It should be easy to add diagrams to your Markdown documentation. There are many solutions that can render diagrams inside Markdown; for example, see Asciidoctor.
However, if you want to add a custom diagram, it can be tedious to implement. Core idea: If you have a function that can produce a diagram as SVG, it should be trivial to use it in Astro (or other SSGs that use remark/rehype).
It should be easy to create documentation with many diagrams, like in Byrne's Elements of Euclid.
I have implemented core packages and added some examples. However, I still need to add more tests, configure CI, create a demo site, and address the remaining TODOs.
| rehype | |
|---|---|
| Graphviz | @beoe/rehype-graphviz |
| Mermaid | @beoe/rehype-mermaid |
| Gnuplot | @beoe/rehype-gnuplot |
| Vizdom | @beoe/rehype-vizdom |
| D2 | @beoe/rehype-d2 |
| Penrose | |
| ... |
Ideas for other diagrams: Text to Diagram.
The logo is an illustration from Oliver Byrne's Elements of Euclid: The First Six Books with Coloured Diagrams and Symbols.
- try to implement external file strategy (with vfile)
- reuse svgStrategy in all plugins
- add
processMetato all plugins, so it would be possible to configureclassandstrategy - maybe rename strategies