The Wayback Machine - https://web.archive.org/web/20200929065243/https://github.com/aleen42/gitbook-mindmaps
Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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

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

TODO

  • Use unlimited headings for generating mind maps

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

How to contribute

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

📜 License

MIT © aleen42

About

☁️ A GitBook plugin for generating mindmaps within Markdown.

Resources

License

Packages

No packages published
You can’t perform that action at this time.