search

klaytn / kips

Website
https://kips.klaytn.foundation
18 stars 40 forks source link

Render mermaid diagrams in KIPs #145

Closed blukat29 closed 1 year ago

blukat29 commented 1 year ago

Support the Mermaid diagrams in KIP pages.

How to use

In a KIP-xx.md file, simply add a code block with mermaid language. See the docs for syntax.

```mermaid
flowchart LR
  A-->B


## Rationale

- Because [GitHub supports it](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/), we can seamlessly see it in both PR reviews and the KIP website.
- Having diagrams in the KIP-xx.md itself makes the document more portable and self-contained.
- Allows easy and collaborative diagram editing.
- There was the same [proposal in EIP](https://github.com/ethereum/EIPs/issues/2450).