Skip to content

Commit 81a137e

Browse files
author
neatc0der
committed
add usage description to readme
1 parent 3bab091 commit 81a137e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,34 @@ plugins:
3434
- markmap
3535
```
3636
37+
## Usage
38+
39+
This plugin supports code blocks of markdown as follows:
40+
41+
````markdown
42+
```markmap
43+
# Root
44+
45+
## Branch 1
46+
47+
* Branchlet 1a
48+
* Branchlet 1b
49+
50+
## Branch 2
51+
52+
* Branchlet 2a
53+
* Branchlet 2b
54+
```
55+
````
56+
57+
It can also make use of file includes whereever you need them to be:
58+
59+
```markdown
60+
Look at this beautiful mindmap:
61+
62+
{!mindmap.mm.md!}
63+
```
64+
3765
## Advanced Settings
3866
3967
There are more options available for `mkdocs.yml` (shown values are defaults):

0 commit comments

Comments
 (0)