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

Support curly brackets around code block language/graph type name #286

Open
arwedus opened this issue Feb 3, 2023 · 0 comments
Open

Support curly brackets around code block language/graph type name #286

arwedus opened this issue Feb 3, 2023 · 0 comments

Comments

@arwedus
Copy link

arwedus commented Feb 3, 2023

With the popular MyST Markdown syntax, Markdown is a first-level markup language for Sphinx.

The syntax for sphinx directives with MyST markdown is:

```{directivename}
:options:
content
```

There are Sphinx extensions to support in-line text-based diagram generators for:

  • plantuml (directive: uml)
  • graphviz (directive: graphviz)
  • ditaa (directive: ditaa
  • mermaid (directive: mermaid)

For example with plantuml, and a custom alias ("plantuml") for the .. uml:: directive, I would write:

# Document with plantuml Diagram

```{plantuml}
@startuml
A -> B
B -> A
@enduml
```

Now, I'd like to have this fenced code block rendered inline as PlantUML diagram in the enhanced markdown preview. Btw., this works with the VS Code standard Markdown previewer and the jebbs.plantuml extension.

I have already checked out in the code that this could be implemented by extending a regular expression in process-graphs.ts... I could open a pull request. Would you be open to include this change?

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

1 participant