markmap-lib

markmap-lib

Visualize your Markdown as mindmaps.

This project is heavily inspired by dundalek's markmap.

Try it out.

Node.js >= 10 is required.

Installation

$ yarn add markmap-lib
# or
$ npm install markmap-lib

See markmap-cli for command-line usage.

API

Transform

Transform Markdown to markmap data:

import { transform } from 'markmap-lib/dist/transform';

const data = transform(markdown);

Now we get the data for rendering in data.

Render

Render a markmap from transformed data:

Create an SVG element with explicit width and height:

<svg id="markmap" style="width: 800px; height: 800px"></svg>

Render a markmap to the SVG element:

import { Markmap } from 'markmap-lib/dist/view';

Markmap.create('#markmap', null, data);

// or pass an SVG element directly
const svgEl = document.querySelector('#markmap');
Markmap.create(svgEl, null, data);