# markmap

> Visualize markdown documents as mindmaps

Latest version **0.6.1** (published 2019-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install markmap
pnpm add markmap
yarn add markmap
bun add markmap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.1 |
| Published | 2019-10-23 |
| First published | 2015-07-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 336.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1976 |
| Author | Jakub Dundalek |
| Maintainers | dundalek |
| Keywords | markdown, mindmap, ideamap, visualization |

## Links

- npm: https://www.npmjs.com/package/markmap
- Repository: https://github.com/dundalek/markmap
- Homepage: https://github.com/dundalek/markmap#readme
- Issues: https://github.com/dundalek/markmap/issues
- npm.io page: https://npm.io/package/markmap

## Dependencies (2)

- [d3](https://npm.io/package/d3.md) 3.5.6
- [remarkable](https://npm.io/package/remarkable.md) 1.7.4

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.6.1 (latest) — 2019-10-23
- 0.6.0 — 2018-11-08
- 0.5.0 — 2018-09-10
- 0.4.2 — 2017-10-09
- 0.4.1 — 2017-09-08
- 0.4.0 — 2017-08-27
- 0.3.3 — 2017-01-16
- 0.3.2 — 2016-12-19
- 0.3.1 — 2015-08-27
- 0.3.0 — 2015-08-06
- 0.2.1 — 2015-08-01
- 0.2.0 — 2015-07-30
- 0.1.0 — 2015-07-25
- 0.0.1 — 2015-07-17

## README

# markmap

[![Build status on CircleCI](https://circleci.com/gh/dundalek/markmap.svg?style=shield)](https://circleci.com/gh/dundalek/markmap) [![npm version](https://img.shields.io/npm/v/markmap.svg)](https://www.npmjs.com/package/markmap)

*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](http://kb.knomaton.org/multi-agent-systems/). It is also used in an [extension](https://atom.io/packages/markdown-mindmap) for Atom editor.

| ![markmap in action](doc/img/mindmap-screenshot2.png) | ![markmap in action](doc/img/mindmap-screenshot1.png) |
|:-:|:-:|
| Default style | Colorful style |


## Features

- Zoom in and out with the mouse wheel.
- Pan around by dragging the backgroud.
- 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 featues are welcome, feel free to open an [issue](https://github.com/dundalek/markmap/issues).

## How to use

Install the component with NPM:
```
npm install markmap
```

Visualizing a markdown text consists of two steps:

1. The text is parsed and transformed into a tree representation.
2. The tree is rendered.

### Examples

To run the examples first clone the project and install dependencies:

```sh
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](examples/browser) folder.

#### Node.js

Node examples are located in [examples/node](examples/node). You can run the markdown example or others as follows:

```sh
cd examples/node
node example.markdown.js
```

## Changelog

### [0.6.1](https://github.com/dundalek/markmap/compare/v0.6.0...v0.6.1) (2019-10-23)

- Bump dependencies to fix vulnerabilities

### [0.6.0](https://github.com/dundalek/markmap/compare/v0.5.0...v0.6.0) (2018-11-08)

- **Breaking change**: Moved sources from src to lib. That way there will be no breakage if we happen to introduce babel in the future.
- Added tree diffing heuristic
- Added more code examples
- Fixed link parsing issues

### [0.5.0](https://github.com/dundalek/markmap/compare/v0.4.2...v0.5.0) (2018-09-10)

- **Breaking change**: Changed structure of source files
- Added support for parsing inter file links for markdown
- Updated code examples

## License

The MIT License.

---
_Source: https://npm.io/package/markmap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._