{"id":25253252,"url":"https://github.com/markmap/mkdocs_markmap","last_synced_at":"2025-10-10T09:05:37.182Z","repository":{"id":44716975,"uuid":"331991776","full_name":"markmap/mkdocs_markmap","owner":"markmap","description":"MkDocs plugin and extension to create mindmaps from markdown using markmap","archived":false,"fork":false,"pushed_at":"2025-02-11T20:33:32.000Z","size":114,"stargazers_count":69,"open_issues_count":4,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-08-21T22:51:37.761Z","etag":null,"topics":["markdown","markmap","mindmap","mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markmap.png","metadata":{"files":{"readme":"README.md","changelog":"changelog/v0.1.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-22T15:52:32.000Z","updated_at":"2025-08-06T11:40:40.000Z","dependencies_parsed_at":"2025-02-11T21:39:38.600Z","dependency_job_id":null,"html_url":"https://github.com/markmap/mkdocs_markmap","commit_stats":{"total_commits":126,"total_committers":3,"mean_commits":42.0,"dds":0.1428571428571429,"last_synced_commit":"8679dd54697ed5277b5a05aeb7b9cf5b290876b8"},"previous_names":["markmap/mkdocs_markmap","markmap/mkdocs-markmap","neatc0der/mkdocs-markmap"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/markmap/mkdocs_markmap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmap%2Fmkdocs_markmap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmap%2Fmkdocs_markmap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmap%2Fmkdocs_markmap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmap%2Fmkdocs_markmap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markmap","download_url":"https://codeload.github.com/markmap/mkdocs_markmap/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markmap%2Fmkdocs_markmap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279003389,"owners_count":26083579,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markmap","mindmap","mkdocs","mkdocs-plugin"],"created_at":"2025-02-12T04:58:49.135Z","updated_at":"2025-10-10T09:05:37.153Z","avatar_url":"https://github.com/markmap.png","language":"Python","readme":"# mkdocs-markmap\n\n\u003e Beautiful and simple mindmaps written in markdown.\n\n[![MIT license](https://badgen.net/github/license/markmap/mkdocs-markmap)](https://github.com/markmap/mkdocs-markmap/blob/master/LICENSE)\n[![PyPI](https://badgen.net/pypi/v/mkdocs-markmap)](https://pypi.org/project/mkdocs-markmap/)\n[![Latest Release](https://badgen.net/github/release/markmap/mkdocs-markmap/latest)](https://github.com/markmap/mkdocs-markmap/releases/latest)\n[![Open Issues](https://badgen.net/github/open-issues/markmap/mkdocs-markmap)](https://github.com/markmap/mkdocs-markmap/issues)\n[![Open PRs](https://badgen.net/github/open-prs/markmap/mkdocs-markmap)](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.18\n      view_version: 0.18\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.18/dist/browser/index.iife.js\n  - https://unpkg.com/markmap-view@0.18/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","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkmap%2Fmkdocs_markmap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkmap%2Fmkdocs_markmap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkmap%2Fmkdocs_markmap/lists"}