MkDocs plugin and extension to creates mindmaps from markdown using markmap
Project description
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.9
- mkdocs 1.3
Quickstart
Install
pip install mkdocs-markmap
Configure
Add this to mkdocs.yml
:
plugins:
- markmap
Usage
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!}
Advanced Settings
There are more options available for mkdocs.yml
(shown values are defaults):
plugins:
- markmap:
base_path: docs
encoding: utf-8
file_extension: .mm.md
d3_version: 6.7.0
lib_version: 0.11.6
view_version: 0.2.6
In addition, feel free to define your favourite source urls like this:
extra_javascript:
- https://unpkg.com/d3@6.7.0/dist/d3.min.js
- https://unpkg.com/markmap-lib@0.11.6/dist/browser/index.min.js
- https://unpkg.com/markmap-view@0.2.6/dist/index.min.js
:warning: The urls need to contain one of these keywords to be considered as deviation from default:
markmap-d3
markmap-lib
markmap-view
Troubleshooting
Nav tree lists markmaps
- Move your markmap files to a separate folder next to
docs
, e.g.mindmaps
- Configure
base_path
accordingly (see Advanced Settings)
Static javascript files not working
- Ensure naming of javascript files matches the scheme (see Advanced Settings)
- Copy all javascript files to
doc/js/
, otherwisemkdocs
will not copy static files tosite/
- Define all files in
extra_javascript
, e.g.
extra_javascript:
- js/markmap-d3.js
- js/markmap-lib.js
- js/markmap-view.js
Usage of proxy is preventing download of javascript files
Usually proxies should be supported by requests
, which is used for downloading all required javascript files. If the issue remains, try downloading the files yourself and store them accordingly (see Static javascript files not working)
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs_markmap-2.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9eb35e1d4eb42b3f8a085c57fd9d5b510a1e4cb5dde276b9a58918af33c156eb |
|
MD5 | 9bdcbe2d6bb50e9bd46dd55bd26bc01a |
|
BLAKE2b-256 | 6be367f68782c998e1eed6543b48fcd9363f09df2e1a5ee3721399590081df06 |