ChainSafe / engineering-handbook

ChainSafe Engineering Handbook
https://handbook.chainsafe.io
Apache License 2.0
6 stars 2 forks source link

Add support for svgbob for text base diagrams #19

Open ivanceras opened 2 years ago

ivanceras commented 2 years ago

It would be nice that the diagrams can be created by just using plain text and use svgbob to render it to svg in the page view. This simplifies a lot of workflow, such as not having to put binary format image into the repo. The text base diagrams can also be updated using simple text editors.

Svgbob is starting to get some traction:

AsciiDoctor Discourse theme kroki

There is also some blogs that touched on svgbob

mpetrunic commented 2 years ago

We would need plugin like this: https://github.com/sjwall/mdx-mermaid https://github.com/ChainSafe/engineering-wiki/blob/main/docusaurus.config.js#L35