aleen42 / gitbook-mindmaps

:cloud: A GitBook plugin for generating mindmaps within Markdown.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gitbook-mindmaps

A GitBook plugin for generating mindmaps with Markdown, and see the Demo directly.

npm javascript gitbook gitbook

GitHub license npm

mind-maps

Installation

Add the following plugins to your book.json and run the command gitbook install

{
	"plugins": ["mind-maps"]
}

Usage

  1. Generate mind maps with Markdown headings syntax:

    ```mind:height=300,title=a mind map of something,color
    # 1
    ## 1.1
    ### 1.1.1
    ## 1.2
    # 2
    # 3
    ```
    • height (optional): to specify the map height
    • title (optional): to specify a title for this map
    • color (optional): to generate a colorful map
  2. Generate with Markdown list items syntax:

    ```mind
    - 1
      - 1.1
        - 1.1.1
      - 1.2
    - 2
    - 3
    ``` 

TODO

  • Use unlimited headings for generating mind maps
  • Support HTML tags

Release History

  • ==================== 1.0.0 Initial release ====================
    • 1.0.4 bug fix
    • 1.0.5 fix empty line
    • 1.0.8 style enhancement
    • 1.0.9 support custom border color
    • 1.1.0 remove nested restriction in remarkable #1
    • 1.1.4 support HTML tags #2
    • 1.1.7 use gitbook-color to support light or dark theme
    • 1.1.9 import eslint

⛽ How to contribute

Have an idea? Found a bug? See how to contribute.

📜 License

MIT © aleen42

Note: if you like this project, feel free to buy me a swimming chance:

badges badges badges

About

:cloud: A GitBook plugin for generating mindmaps within Markdown.

License:MIT License


Languages

Language:JavaScript 99.8%Language:HTML 0.2%