Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

stereobooster/beoe

Repository files navigation

BEOE

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.

Status

I have implemented core packages and added some examples. However, I still need to add more tests, and address the remaining TODOs.

Packages

Diagrams

rehype
Graphviz @beoe/rehype-graphviz
Mermaid @beoe/rehype-mermaid
Gnuplot @beoe/rehype-gnuplot
Vizdom @beoe/rehype-vizdom
D2 @beoe/rehype-d2
Penrose @beoe/rehype-penrose
...

Ideas for other diagrams: Text to Diagram.

Core

Logo

The logo is an illustration from Oliver Byrne's Elements of Euclid: The First Six Books with Coloured Diagrams and Symbols.

Contributors 2

AltStyle によって変換されたページ (->オリジナル) /