Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Decide on directive leading characters. #114

Open
Mpdreamz opened this issue Dec 17, 2024 · 2 comments
Open

Decide on directive leading characters. #114

Mpdreamz opened this issue Dec 17, 2024 · 2 comments
Labels
authoring Relates to our markdown parser

Comments

@Mpdreamz
Copy link
Member

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:

Image

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 ?

@Mpdreamz Mpdreamz added the authoring Relates to our markdown parser label Dec 17, 2024
@KOTungseth
Copy link

KOTungseth commented Dec 17, 2024

My vote would be for all our documentation we use ::: over triple backticks.

I fully support this.

Why?

Because I've been burned using ' instead of ` way too many times.

@bmorelli25
Copy link
Member

👍 Makes sense to me. Let's do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authoring Relates to our markdown parser
Projects
None yet
Development

No branches or pull requests

3 participants