# mkdocs-markmap
> Beautiful and simple mindmaps written in markdown.
[](https://github.com/markmap/mkdocs-markmap/blob/master/LICENSE)
[](https://pypi.org/project/mkdocs-markmap/)
[](https://github.com/markmap/mkdocs-markmap/releases/latest)
[](https://github.com/markmap/mkdocs-markmap/issues)
[](https://github.com/markmap/mkdocs-markmap/pulls)
This is a plugin and an extension for [mkdocs](https://github.com/mkdocs/mkdocs/) to add [markmap](https://github.com/markmap/markmap).
## Prerequisits
This plugin was tested with, but is not limited to:
* Python 3.9
* mkdocs 1.3
## Quickstart
### Install
```bash
pip install mkdocs-markmap
```
### Configure
Add this to `mkdocs.yml`:
```yaml
plugins:
- markmap
```
## Usage
This plugin supports code blocks of markdown as follows:
````markdown
```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:
```markdown
Look at this beautiful mindmap:
{!mindmap.mm.md!}
```
## Advanced Settings
There are more options available for `mkdocs.yml` (shown values are defaults):
```yaml
plugins:
- markmap:
base_path: docs
encoding: utf-8
file_extension: .mm.md
d3_version: 7
lib_version: 0.15.3
view_version: 0.15.3
```
In addition, feel free to define your favourite source urls like this:
```yaml
plugins:
- markmap:
# disable the default assets first
d3_version: ''
lib_version: ''
view_version: ''
extra_javascript:
- https://unpkg.com/d3@7/dist/d3.min.js
- https://unpkg.com/markmap-lib@0.15.3/dist/browser/index.js
- https://unpkg.com/markmap-view@0.15.3/dist/browser/index.js
```
## Troubleshooting
### Nav tree lists markmaps
1. Move your markmap files to a separate folder next to `docs`, e.g. `mindmaps`
2. Configure `base_path` accordingly (see [Advanced Settings](#advanced-settings))
### Static javascript files not working
1. Ensure naming of javascript files matches the scheme (see [Advanced Settings](#advanced-settings))
2. Copy all javascript files to `doc/js/`, otherwise `mkdocs` will not copy static files to `site/`
3. Define all files in `extra_javascript`, e.g.
```yaml
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](#static-javascript-files-not-working))
## Credits :clap:
Some of the development approaches are based on implementations provided by the following projects:
* [markmap](https://github.com/markmap/markmap) (key feature of this project)
* [markdown-include](https://github.com/cmacmackin/markdown-include) (basis for extension support)
* [mkdocs-mermaid2-plugin](https://github.com/fralau/mkdocs-mermaid2-plugin) (basis for plugin support)
Raw data
{
"_id": null,
"home_page": "https://github.com/markmap/mkdocs-markmap",
"name": "mkdocs-markmap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "mkdocs python markdown markmap mindmap include",
"author": "neatc0der",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/51/b7/8a751c5bc6d81cef11d24cef9d02491d3e1b768b79542c15fb08e69d9917/mkdocs-markmap-2.4.3.tar.gz",
"platform": null,
"description": "# mkdocs-markmap\n\n> Beautiful and simple mindmaps written in markdown.\n\n[](https://github.com/markmap/mkdocs-markmap/blob/master/LICENSE)\n[](https://pypi.org/project/mkdocs-markmap/)\n[](https://github.com/markmap/mkdocs-markmap/releases/latest)\n[](https://github.com/markmap/mkdocs-markmap/issues)\n[](https://github.com/markmap/mkdocs-markmap/pulls)\n\nThis is a plugin and an extension for [mkdocs](https://github.com/mkdocs/mkdocs/) to add [markmap](https://github.com/markmap/markmap).\n\n## Prerequisits\n\nThis plugin was tested with, but is not limited to:\n\n* Python 3.9\n* mkdocs 1.3\n\n## Quickstart\n\n### Install\n\n```bash\npip install mkdocs-markmap\n```\n\n### Configure\n\nAdd this to `mkdocs.yml`:\n\n```yaml\nplugins:\n - markmap\n```\n\n## Usage\n\nThis plugin supports code blocks of markdown as follows:\n\n````markdown\n```markmap\n# Root\n\n## Branch 1\n\n* Branchlet 1a\n* Branchlet 1b\n\n## Branch 2\n\n* Branchlet 2a\n* Branchlet 2b\n```\n````\n\nIt can also make use of file includes to keep your markdown tidy:\n\n```markdown\nLook at this beautiful mindmap:\n\n{!mindmap.mm.md!}\n```\n\n## Advanced Settings\n\nThere are more options available for `mkdocs.yml` (shown values are defaults):\n\n```yaml\nplugins:\n - markmap:\n base_path: docs\n encoding: utf-8\n file_extension: .mm.md\n d3_version: 7\n lib_version: 0.15.3\n view_version: 0.15.3\n```\n\nIn addition, feel free to define your favourite source urls like this:\n\n```yaml\nplugins:\n - markmap:\n # disable the default assets first\n d3_version: ''\n lib_version: ''\n view_version: ''\n\nextra_javascript:\n - https://unpkg.com/d3@7/dist/d3.min.js\n - https://unpkg.com/markmap-lib@0.15.3/dist/browser/index.js\n - https://unpkg.com/markmap-view@0.15.3/dist/browser/index.js\n```\n\n## Troubleshooting\n\n### Nav tree lists markmaps\n\n1. Move your markmap files to a separate folder next to `docs`, e.g. `mindmaps`\n2. Configure `base_path` accordingly (see [Advanced Settings](#advanced-settings))\n\n### Static javascript files not working\n\n1. Ensure naming of javascript files matches the scheme (see [Advanced Settings](#advanced-settings))\n2. Copy all javascript files to `doc/js/`, otherwise `mkdocs` will not copy static files to `site/`\n3. Define all files in `extra_javascript`, e.g.\n\n```yaml\nextra_javascript:\n - js/markmap-d3.js\n - js/markmap-lib.js\n - js/markmap-view.js\n```\n\n### Usage of proxy is preventing download of javascript files\n\nUsually 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](#static-javascript-files-not-working))\n\n## Credits :clap:\n\nSome of the development approaches are based on implementations provided by the following projects:\n\n* [markmap](https://github.com/markmap/markmap) (key feature of this project)\n* [markdown-include](https://github.com/cmacmackin/markdown-include) (basis for extension support)\n* [mkdocs-mermaid2-plugin](https://github.com/fralau/mkdocs-mermaid2-plugin) (basis for plugin support)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin and extension to creates mindmaps from markdown using markmap",
"version": "2.4.3",
"project_urls": {
"Homepage": "https://github.com/markmap/mkdocs-markmap"
},
"split_keywords": [
"mkdocs",
"python",
"markdown",
"markmap",
"mindmap",
"include"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19afafb1090828c933a7f04356405f22c795dd8788b52b83a13d378c0b1620ab",
"md5": "d8ed01040ee3e38ffdf7483c02809267",
"sha256": "de5e78d829df40be8cce3581c75c9a0fd915b4c3044bfed69f99a975e6805e45"
},
"downloads": -1,
"filename": "mkdocs_markmap-2.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8ed01040ee3e38ffdf7483c02809267",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10113,
"upload_time": "2023-10-05T16:20:54",
"upload_time_iso_8601": "2023-10-05T16:20:54.756768Z",
"url": "https://files.pythonhosted.org/packages/19/af/afb1090828c933a7f04356405f22c795dd8788b52b83a13d378c0b1620ab/mkdocs_markmap-2.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51b78a751c5bc6d81cef11d24cef9d02491d3e1b768b79542c15fb08e69d9917",
"md5": "cc4a62a0ae3a9e6a1aded4cce8499c6c",
"sha256": "faf5e91426cc3794aa24dd0f55e9c1710bc42be68e9eebf996cca255ec6f2849"
},
"downloads": -1,
"filename": "mkdocs-markmap-2.4.3.tar.gz",
"has_sig": false,
"md5_digest": "cc4a62a0ae3a9e6a1aded4cce8499c6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9828,
"upload_time": "2023-10-05T16:20:56",
"upload_time_iso_8601": "2023-10-05T16:20:56.449777Z",
"url": "https://files.pythonhosted.org/packages/51/b7/8a751c5bc6d81cef11d24cef9d02491d3e1b768b79542c15fb08e69d9917/mkdocs-markmap-2.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 16:20:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "markmap",
"github_project": "mkdocs-markmap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-markmap"
}
JSON
