Metadata-Version: 2.1
Name: mkdocs-markmap
Version: 2.1.2
Summary: MkDocs plugin and extension to creates mindmaps from markdown using markmap
Home-page: https://github.com/neatc0der/mkdocs-markmap
Author: neatc0der
Author-email: 
License: MIT
Description: # mkdocs-markmap
        
        > Beautiful and simple mindmaps written in markdown.
        
        [![MIT license](https://badgen.net/github/license/neatc0der/mkdocs-markmap)](https://github.com/neatc0der/mkdocs-markmap/blob/master/LICENSE)
        [![PyPI](https://badgen.net/pypi/v/mkdocs-markmap)](https://pypi.org/project/mkdocs-markmap/)
        [![Latest Release](https://badgen.net/github/release/neatc0der/mkdocs-markmap/latest)](https://github.com/neatc0der/mkdocs-markmap/releases/latest)
        [![Open Issues](https://badgen.net/github/open-issues/neatc0der/mkdocs-markmap)](https://github.com/neatc0der/mkdocs-markmap/issues)
        [![Open PRs](https://badgen.net/github/open-prs/neatc0der/mkdocs-markmap)](https://github.com/neatc0der/mkdocs-markmap/pulls)
        
        This is a plugin and an extension for [mkdocs](https://github.com/mkdocs/mkdocs/) to add [markmap](https://github.com/gera2ld/markmap).
        
        ## Prerequisits
        
        This plugin was tested with, but is not limited to:
        
        * Python 3.8
        * mkdocs 1.1
        
        ## 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: 6.7.0
              lib_version: 0.11.5
              view_version: 0.2.6
        ```
        
        In addition, feel free to define your favourite source urls like this:
        
        ```yaml
        extra_javascript:
          - https://unpkg.com/d3@6.7.0/dist/d3.min.js
          - https://unpkg.com/markmap-lib@0.11.5/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:
        
        * `d3`
        * `markmap-lib`
        * `markmap-view`
        
        ## Credits :clap:
        
        Some of the development approaches are based on implementations provided by the following projects:
        
        * [markmap](https://github.com/gera2ld/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)
        
Keywords: mkdocs python markdown markmap mindmap include
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
