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

Compatibility with snippets #89

Open
watermarkhu opened this issue Jan 9, 2025 · 2 comments
Open

Compatibility with snippets #89

watermarkhu opened this issue Jan 9, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@watermarkhu
Copy link

watermarkhu commented Jan 9, 2025

Is your feature request related to a problem? Please describe.
To keep the Markdown file as clean as possible. It would be great if mkdocs-puml would be compatible with snippets.

Using snippets, the PlantUML diagrams can remain as separate files.

mkdocs.yml
docs
|-- diagram.puml
|-- index.md

The diagram would be generated with the following syntax in index.md.

```puml
--8<-- "docs/diagram.puml
```

Currently, the mkdocs-puml plugin is triggered before any markdown extensions are evaluated. Resulting in the following:
image

@watermarkhu
Copy link
Author

Alternatively, I see that mkdocs-d2-plugins implements import tags https://landmaj.github.io/mkdocs-d2-plugin/guide/configuration/#image-tags

@MikhailKravets
Copy link
Owner

Hi @watermarkhu! Thanks for this suggestion and the link above 🔥 This is a great idea to add the support for snippets to the plugin. I'll take a look to that of course. I can't promise it will be right away but in the nearest future for sure.

@MikhailKravets MikhailKravets added the enhancement New feature or request label Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants