https://github.com/cldwalker/mermaid

Light Table plugin that generates diagrams and flowcharts from text using mermaid
https://github.com/cldwalker/mermaid

Last synced: 7 months ago
JSON representation

Light Table plugin that generates diagrams and flowcharts from text using mermaid

• Host: GitHub
• URL: https://github.com/cldwalker/mermaid
• Owner: cldwalker
• License: mit
• Created: 2014-12-12T17:03:40.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-12-12T17:18:41.000Z (over 11 years ago)
• Last Synced: 2025-04-06T18:53:02.760Z (about 1 year ago)
• Language: JavaScript
• Size: 379 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
## Description

Mermaid is a Light Table plugin that generates diagrams and flowcharts from text using [mermaid](https://github.com/knsv/mermaid).

![Usage Example](example.gif)

## Install

Install this plugin with LT's plugin manager or clone this project to your LT

plugins directory.

## Usage

Open a new file `Cmd-n` and execute the Mermaid command to watch your file and open a live tab. Any text you type

is watched and automatically generates a diagram in the live tab.

See the [Mermaid readme](https://github.com/knsv/mermaid#readme) for the different kinds of diagrams you can make.

This is currently using mermaid 0.2.12.

## Bugs/Issues

Please report them [on github](http://github.com/cldwalker/Mermaid/issues).

## TODO

* Add a command to export generated svg based on http://bl.ocks.org/mbostock/6466603. Contribution

  most welcome as this method seems to lose a lot of styling.

## License

See LICENSE.txt

## Credits

* Thanks to @cognitect for open source fridays!