Skip to content

gavbarnett/markdown-chess

Repository files navigation

markdown-chess README

Markdown-chess is a VSCode extension for markdown files for chess.

It extends markdown with the chess functionality you've always wanted!

Features

The Basic Board

Using chess code blocks you can describe a chess position in a very similar way to Wikipedia's {{Chess diagram}} format

Chess pieces are notated by their letter below followed by l for light/white or d for dark/black:

  • k - king
  • q - queen
  • r - rook
  • b - bishop
  • n - night
  • p - pawn

So the white king would be notated by kl.

Board Generation

You can add highlights to squares using symbols:

  • * Highlight Square (blue in default theme)
  • ! Highlight Attack (red in default theme)

You can add hints using these symbols:

  • . hint move option
  • o or .[piece] hint attack option

Combining these you can start to build a board with clear annotation both in markdown and when converted to svg format for preview:

Board Generation

Known Issues

Release Notes

About

Adds chess diagrams to markdown preview

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published