haiyangToAI
commented
2 years ago Hi @alcarney,
I like the idea of Esbonio to support Sphinx directives and roles for MyST/Markdown files. It will be helpful.
Directives and roles in MyST/Markdown look like this, see MyST Docs:
-
directive patterns:
-
Using YAML frontmatter for directive options:
--- key1: val1 key2: val2 --- This is directive content -
Using short-hand options with
:characters:key1: val1 :key2: val2 This is directive content -
Using
eval-rstdirective.. {directivename}:: arguments :key1: val1 :key2: val2 This is directive content.
-
-
role pattern
- {role-name}
role content
- {role-name}
To support directives and roles for MyST/Markdown, Esbonio need to:
-
For directives:
-
if {eval-rst} used, then it's no different as rst file. Esbonio language server doesn't need to do anything.
-
if pattern
{directive} used, then Esbonio need to add new trigger, the { character, left curly bracket, then check string pattern starts with{. -
if directive option using YAML frontmatter, the triger for options can be tricky, maybe need another trigger, but don't know how yet.
-
if directive option using : character, then it's the same for rst file. Esbonio does not need to do anything.
-
For roles:
-
Esbonio need to add new trigger, the { character.
-
What do you think this approach? @alcarney @danwos
By adding a new trigger {, then Esbonio can already support roles and directives that using short-hand options and eval-rst. If you think this is the way, then I will prepare a PR.
alcarney
davbeek
astrojuanlu
chrisjsewell
MyST is a flavour of markdown that is compatible with Sphinx. It should be possible to add just by calling out to the existing directive/roles logic where applicable