https://github.com/up9cloud/docsify-mindmap
Mind map plugin for docsify
https://github.com/up9cloud/docsify-mindmap
Last synced: about 1 year ago
JSON representation
Mind map plugin for docsify
- Host: GitHub
- URL: https://github.com/up9cloud/docsify-mindmap
- Owner: up9cloud
- License: mit
- Created: 2019-09-04T00:23:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-01T00:09:05.000Z (over 1 year ago)
- Last Synced: 2025-04-10T23:17:08.664Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://up9cloud.github.io/docsify-mindmap
- Size: 275 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docsify-mindmap
Mind map plugin for [docsify](https://github.com/docsifyjs/docsify).
## Usage
```html
window.$docsify = {
mindmap: {
// https://github.com/dundalek/markmap
markmap: {
preset: 'colorful', // or default
linkShape: 'diagonal' // or bracket
}
}
}
```
````md
# Plain text
```mindmap
root
topic1
subtopic
topic2
subtopic
```
````
````md
# JSON tree format
```mindmap json-tree
{
"name": "root",
"children": [
{
"name": "topic1",
"children": [{ "name": "subtopic" }]
},
{
"name": "topic2",
"children": [{ "name": "subtopic" }]
}
]
}
```
````
> See [demo](http://up9cloud.github.io/docsify-mindmap) for more format
## Dev memo
```bash
npm i
npm run dev
```
## TODO
- [ ] Stop d3 resizing
- [ ] To find another light weight mindmap render engine
- [ ] Support markmap-lib