-
Notifications
You must be signed in to change notification settings - Fork 32
Closed
Labels
authoringRelates to our markdown parserRelates to our markdown parserquestionFurther information is requestedFurther information is requested
Description
Today we support both:
```{directive} arguments
:option: value
<content>
```as well as:
:::{directive} arguments
:option: value
<content>
:::The latter is recommended by Myst itself: https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-colon-fence because it plays better with markdown editors and syntax highlighting.
As can be seen right here on GitHub:
```{directive} arguments
:option: value
# hello world
[a link](http://www.google.com] with **bold** text
```:::{directive} arguments
:option: value
# hello world
[a link](http://www.google.com] with **bold** text
:::or as seen in an code editor:
Although this is less of an issue with the MYST plugin for VS code:
https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight
Intelij has no Myst support although its being tracked:
https://youtrack.jetbrains.com/issue/PY-61291/Support-MyST-syntax
My vote would be for all our documentation we use ::: over triple backticks.
WDTY: @bmorelli25 @KOTungseth @siamakp-elastic ?
Metadata
Metadata
Assignees
Labels
authoringRelates to our markdown parserRelates to our markdown parserquestionFurther information is requestedFurther information is requested