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

Add alias for plantuml directive #88

Closed
stephanlachnit opened this issue Feb 20, 2024 · 0 comments · Fixed by #89
Closed

Add alias for plantuml directive #88

stephanlachnit opened this issue Feb 20, 2024 · 0 comments · Fixed by #89

Comments

@stephanlachnit
Copy link
Contributor

Currently, only the uml directive is supported. It would be nice if plantuml as a alias to the uml directive could be added.

The main argument for this is support for PlantUML rendering with GitLab in Markdown. It supports PlantUML via:

```plantuml
Bob -> Alice : hello
Alice -> Bob : hi
```

If you use MyST to use Markdown with sphinx, PlantUML via sphinxcontrib.plantuml only works with a {uml} code fence:

```{uml}
Bob -> Alice : hello
Alice -> Bob : hi
```

This is unfortunate because this means you can't use the same file to render both with GitLab and sphinx.

However, if the plantuml directive would be supported, one could set

myst_fence_as_directive = ["plantuml"]

in the sphinx config to support the default GitLab rendering.

stephanlachnit added a commit to stephanlachnit/plantuml that referenced this issue Feb 20, 2024
This allows to render PlantUML when using a Markdown parser such as MyST.

Closes sphinx-contrib#88.
@yuja yuja closed this as completed in #89 Feb 21, 2024
yuja pushed a commit that referenced this issue Feb 21, 2024
This allows to render PlantUML when using a Markdown parser such as MyST.

Closes #88.
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

Successfully merging a pull request may close this issue.

1 participant