You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Markmap is a javascript component that will visualize your markdown documents as mindmaps. It is useful for better navigation and overview of the content. You can see it in action online here.
Expand/collapse children of a node by clicking on the circle.
Supported formats:
Markdown
MindMup
Txtmap (whitespace indented plaintext)
Pandoc (limited prototype)
Suggestions for new features are welcome, feel free to open an issue.
How to use
Install the component with NPM:
npm install markmap
Visualizing a markdown text consists of two steps:
The text is parsed and transformed into a tree representation.
The tree is rendered.
Examples
To run the examples first clone the project and install dependencies:
git clone https://github.com/dundalek/markmap.git
cd markmap
npm install
In the examples code there are imports like require('../../lib/somefile'). When using this library in your project you need to change those to require('markmap/lib/somefile').
Browser
Run npm start and a browser will open with the example page where you can see how different formats are parsed and displayed. The source code for browser examples is located in examples/browser folder.
Node.js
Node examples are located in examples/node. You can run the markdown example or others as follows: