documentationjs / documentationjs/documentation

Mermaid support?

Open
#990 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I was wondering if you've considered [Mermaid](https://mermaidjs.github.io) support in `documentation`. (It's a way to describe diagrams textually in markdown files that render nicely.) It seems like it'd be a great alternative to ASCII-art for quite a few documentation tasks.

An example:

```text
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```

would turn in to

![untitled](https://user-images.githubusercontent.com/156557/34838247-05fe7e2a-f6c3-11e7-8e24-26e7b090469c.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.