markmaid

0.1.9 • Public • Published

markmaid Build Status

CLI tool to parse markdown files and renders Mermaid snippets as images.

Requires Node 4.0 or greater.

How it works

  1. Create a readme file with mermaid code snippet (for example, see the readme source for this project).
  2. Run markmaid [filename] | xargs git add
  3. Commit and push
  4. View the rendered result in your Github docs
As flow chart As sequence diagram
img img

It even works in tables!

Installation

Install the markmaid command line tool with npm:

npm install -g markmaid

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.1.9
    2
    • latest

Version History

Package Sidebar

Install

npm i markmaid

Weekly Downloads

2

Version

0.1.9

License

MIT

Last publish

Collaborators

  • nicklasnygren