markdown-diagram

0.1.1 • Public • Published

Markdown-Diagram

How do you build a diagram for the structure in a markdown document? Just read this one.

Command-line interface

In some cases (eg. if your documents are private) you might want to generate this diagrams offline. You can use the CLI to get a static html file like this:

npm i markdown-diagram -g
 
# show all options 
markdown-diagram --help
 
# generate full html doc 
cat ./docs/page/services.md | markdown-diagram > services.html
# OR 
markdown-diagram ./docs/page/services.md > services.html
 
# only the svg diagram 
markdown-diagram --format svg ./docs/page/services.md > services.svg

Package Sidebar

Install

npm i markdown-diagram

Weekly Downloads

1

Version

0.1.1

License

MIT

Last publish

Collaborators

  • beneidel