Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

MyST Syntax for VS Code

Highlights MyST Markdown on top of VS Code’s built-in Markdown highlighting. It highlights the syntax marked ✓ in the TextMate column of the syntax package’s table.

It is the TextMate grammar from the myst-syntax package, and nothing else. It has no activation code and no settings. Its id is myst-author.myst-syntax-vscode, made of the publisher and name in package.json. The MyST Language Server extension depends on that id, so VS Code installs this extension along with it.

Install

It isn’t published yet, so build and install the .vsix from the repository root. Once it is, search for “MyST Syntax” in the Extensions view.

npm install
npm run package -w packages/vscode    # writes packages/vscode/myst-syntax.vsix
code --install-extension packages/vscode/myst-syntax.vsix

npm run package copies the grammar in from packages/syntax and LICENSE from the repo root, then runs vsce package.

Releasing is described in the repository README.