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

Feature request: support MyST directives and roles #100

Open
tarleb opened this issue Jan 18, 2023 · 2 comments
Open

Feature request: support MyST directives and roles #100

tarleb opened this issue Jan 18, 2023 · 2 comments

Comments

@tarleb
Copy link

tarleb commented Jan 18, 2023

MyST (Markedly Structured Text) is a reStructuredText-inspired superset of CommonMark. It comes with two major additions: directives and roles:

  • Directives are code blocks with a special attribute syntax:
    ``` {directiveName} arg1 arg2
    Contents
    ```
  • Roles are similar to the attributes extension, but come before the inline code:
    {role}`text`

MyST is supported by the Jupyter Book project.

@jgm
Copy link
Owner

jgm commented Jan 18, 2023

Would supporting directives and roles fully support MyST, or is there more to it?

What would the semantics of these be?

@tarleb
Copy link
Author

tarleb commented Jan 18, 2023

I believe it would be enough to get basic support, but I'm still learning about MyST and can't answer with confidence. It seems that the contents of those constructs is treated as CommonMark. If these were to be read as code, then a pandoc filter might be enough to add full support.

I'll have to do some experimenting and/or sources reading.

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

No branches or pull requests

2 participants