Scope for Initial Release

[rowanc1]

The extension currently adds syntax that:

• recognizes myst directive syntax
  • adds syntax for name, args and options
• explores ways to bring hover information in (e.g. hover title)
• code folding (just on colon fences for the first pass)
• myst.yml hover information (based on redhats)

It is very hacky at the moment and mostly just exploring possibilities.

For the myst.yml, we should be publishing the schema somewhere (npm, also schemastore). That is probably a new repo that can be built from myst-frontmatter, but also needs to enable the various aliases, fallbacks, etc.

There is a new "language" introduced (myst) and that keys off of two extensions (.md and .myst). The .myst won't work until we add that into the CLI, but that is very simple.

This needs to be merged with the existing markdown spec (here) and then combined with all of the languages, using something like this.

There is some pre-existing work in here:

• Stencila: https://github.com/stencila/stencila/blob/main/vscode/syntaxes/myst/tmGrammar.yaml
• Executable Books - https://github.com/executablebooks/myst-vs-code (e.g. for branding)

That would then allow people to switch between the "markdown" language and myst, even with the .md extension.

I would love to see good documentation support for directives, roles, and directive options. That means importing from myst-directives and using the docs (possibly looking at the myst.yml extensions in the future and loading those!).

Looking forward to working on this with @nokome over the coming weeks!