Skip to content

anhi/nb-mermaid

 
 

Repository files navigation

Make mermaid diagrams in your Jupyter Notebook Markdown

install (easy)

pip install nb-mermaid

In the notebook...

%reload_ext mermaid

install (less easy)

git clone -b gh-pages https://github.com/bollwyvl/nb-mermaid.git \
    ~/.ipython/nbextensions/nb-mermaid

activate

In the notebook...

%%javascript
import notebook
notebook.nbextensions.check_nbextension('nb-mermaid',user=True)
require(['base/js/utils'],
function(utils) {
        utils.load_extensions('nb-mermaid/nb-mermaid');
});

roadmap

  • nbviewer support (bookmarklet works now!)
  • live editing (a la the mermaid editor)
  • pan/zoom
  • search

Build assets

Grab the Mermaid library

bower install

Run coffee and less to generate the

npm install
npm run build

About

Mermaid diagrams in the Jupyter Notebook

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Jupyter Notebook 42.4%
  • Pug 17.4%
  • HTML 15.2%
  • Python 12.9%
  • CoffeeScript 7.1%
  • Shell 2.3%
  • Other 2.7%