mkdocs-markmap 1.1.1

MkDocs plugin and extension to creates mindmaps from markdown using markmap

mkdocs-markmap

Beautiful and simple mindmaps written in markdown.

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

Prerequisits

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

• Python 3.8
• mkdocs 1.1

Quickstart

Install

pip install mkdocs-markmap

Configure

Add this to mkdocs.yml:

markdown_extensions:
  - markmap
plugins:
  - markmap

Advanced Settings

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

markdown_extensions:
  - markmap:
      base_path: docs
      encoding: utf-8
      file_extension: .mm.md
plugins:
  - markmap:
      d3_version: 6.3.1
      lib_version: 0.11.1
      view_version: 0.2.1

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

extra_javascript:
  - https://unpkg.com/d3@6.3.1/dist/d3.min.js
  - https://unpkg.com/markmap-lib@0.11.1/dist/browser/index.min.js
  - https://unpkg.com/markmap-view@0.2.1/dist/index.min.js

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

• d3
• markmap-lib
• markmap-view

Wait, what?! Do I need an extension or a plugin? :unamused:

Q: What does the plugin do?

A: It supports code blocks of markdown as follows:

```markmap
# Root

## Branch 1

* Branchlet 1a
* Branchlet 1b

## Branch 2

* Branchlet 2a
* Branchlet 2b
```

Q: What does the extension do?

A: Well, having such a support is nice, but huge mindmap blocks might be annoying within your tidy markdown files. That is why the extension provides an addition to the markdown syntax. It includes files whereever you need them to be:

Look at this beautiful mindmap:

{!mindmap.mm.md!}

But you do need the plugin for that. Thus, don't forget to follow the quickstart example above.

Credits :clap:

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)