Beautiful and simple mindmaps written in markdown.

This is a plugin and an extension for mkdocs to add markmap.

This plugin was tested with, but is not limited to:

• Python 3.9
• mkdocs 1.1

pip install mkdocs-markmap

Add this to mkdocs.yml:

plugins: - markmap

This plugin supports code blocks of markdown as follows:

```markmap# Root## Branch 1* Branchlet 1a* Branchlet 1b## Branch 2* Branchlet 2a* Branchlet 2b```

It can also make use of file includes to keep your markdown tidy:

Look at this beautiful mindmap:{!mindmap.mm.md!}

There are more options available for mkdocs.yml (shown values are defaults):

plugins: - markmap: base_path: docsencoding: utf-8file_extension: .mm.mdd3_version: 6.7.0lib_version: 0.11.6view_version: 0.2.6

In addition, feel free to define your favourite source urls like this:

extra_javascript: - https://unpkg.com/[email protected]/dist/d3.min.js - https://unpkg.com/[email protected]/dist/browser/index.min.js - https://unpkg.com/[email protected]/dist/index.min.js

⚠️ The urls need to contain one of these keywords to be considered as deviation from default:

• d3
• markmap-lib
• markmap-view

1. Move your markmap files to a separate folder next to docs, e.g. mindmaps
2. Configure base_path accordingly (see Advanced Settings)

Some of the development approaches are based on implementations provided by the following projects:

• markmap (key feature of this project)
• markdown-include (basis for extension support)
• mkdocs-mermaid2-plugin (basis for plugin support)