Skip to content

Commit 0e2c7cd

Browse files
committed
update README
ref #74
1 parent 7ec05df commit 0e2c7cd

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The `:UpdateToc` command, which is designed to update toc manually, can only wor
108108
109109
1. `g:vmt_auto_update_on_save`
110110
111-
default: 1
111+
default: `1`
112112
113113
This plugin will update existing table of contents on save automatic.
114114
@@ -120,7 +120,7 @@ The `:UpdateToc` command, which is designed to update toc manually, can only wor
120120

121121
2. `g:vmt_dont_insert_fence`
122122

123-
default: 0
123+
default: `0`
124124

125125
By default, the `:GenTocXXX` commands will add `<!-- vim-markdown-toc -->` fence to the table of contents, it is designed for feature of auto update table of contents on save and `:UpdateToc` command, it won't effect what your Markdown file looks like after parse.
126126

@@ -158,7 +158,7 @@ The `:UpdateToc` command, which is designed to update toc manually, can only wor
158158

159159
6. `g:vmt_cycle_list_item_markers`
160160

161-
default: 0
161+
default: `0`
162162

163163
By default, `*` is used to denote every level of a list:
164164

@@ -200,6 +200,30 @@ The `:UpdateToc` command, which is designed to update toc manually, can only wor
200200

201201
Include headings before the position you are inserting Table of Contents.
202202

203+
9. `g:vmt_list_indent_text`
204+
205+
default: `''`
206+
207+
The indent text of list item. By default, if `expandtab` is set, it will be `shiftwidth`([2, 5]) number of space, otherwise it will be `\t`. If you set this option, it will override the default behavior.
208+
209+
10. `g:vmt_link`
210+
211+
default: `1`
212+
213+
Whether to generate link for headings.
214+
215+
11. `g:vmt_min_level`
216+
217+
default: `1`
218+
219+
The minimum level of headings to be included in the table of contents.
220+
221+
12. `g:vmt_max_level`
222+
223+
default: `6`
224+
225+
The maximum level of headings to be included in the table of contents.
226+
203227
## Screenshots
204228

205229
* [online demo in English][5]

0 commit comments

Comments
 (0)