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.

Directives and roles

The editor completes directive names, role names, and directive options, and shows mystmd’s description of each on hover. This comes from mystmd-lsp, whose features page lists what it completes and checks.

Completing a directive option

Syntax highlighting

The web editor and VS Code highlight MyST syntax with myst-syntax, which lists what it covers. In JupyterLab, install jupyterlab-myst-syntax from the same repository, as JupyterLab describes.

Known limits

Plugin directives and roles from your myst.yml aren’t in the completion lists, and the fast preview doesn’t render them. The built preview does.