Skip to content
This repository has been archived by the owner on Jan 28, 2024. It is now read-only.

ropez/remarkable-pgn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ARCHIVED

Remarkable plugin for parsing and displaying Chess games

This plugin is basically a Javascript implementation of the Chessboard generator found on this page: http://pgn4web-board.casaschi.net/board-generator.html

It extends markdown with PGN syntax, and inserts an <iframe> showing the Chess game, including variations, commends, annotations etc.

Installation:

npm install --save remarkable remarkable-pgn

Usage:

import Remarkable from 'remarkable';
import RemarkablePGN from 'remarkable-pgn';

const remarkable = new Remarkable();

remarkable.use(RemarkablePGN, { /* options */ });

PGN syntax:

# This is markdown

Include a PGN directly in the markdown text like this:

[PGN]
[Event "Chess Tournament"]
[Site "Chess Club"]
[Date "2016.01.01"]
[Round "1"]
[White "White Player"]
[Black "Black Player"]
[Result "*"]

1. e4 e5 2. Nf3 Nc6 3. Bc4 
[/PGN]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published