Skip to content
This repository has been archived by the owner. It is now read-only.
DEPRECATED Mermaid diagrams in the Jupyter Notebook
Jupyter Notebook HTML CoffeeScript Python Other
Branch: master
Clone or download
Latest commit 103502e Jun 6, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin initial commit Jul 22, 2015
mermaid updating site Jul 28, 2015
notebooks preparing release Jul 28, 2015
.bowerrc starting python module Jul 26, 2015
.gitignore preparing release Jul 28, 2015
.gitmodules starting python module Jul 26, 2015
LICENSE adding license Jul 22, 2015
MANIFEST.in starting python module Jul 26, 2015
README.md reminder to pull in node modules Jun 6, 2016
README.rst
bower.json Bumping some of the npm module versions and mermaid version Jun 6, 2016
package.json Bumping some of the npm module versions and mermaid version Jun 6, 2016
setup.json Bumping some of the npm module versions and mermaid version Jun 6, 2016
setup.py preparing release Jul 28, 2015

README.md

nb-mermaid

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
You can’t perform that action at this time.