Skip to content

Commit 5acf680

Browse files
committed
add note for file type requirements
ref #86
1 parent 0e2c7cd commit 5acf680

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ A vim 7.4+ plugin to generate table of contents for Markdown files.
3636

3737
* Auto update existing table of contents on save.
3838

39+
*Note: This plugin only works in Markdown files, that usually have a .[md|mdown|mkd|mkdn|markdown|mdwn|mdx] suffix. To check file type, please run `:set ft`, Markdown files will echo `filetype=markdown`.*
40+
3941
## Installation
4042

4143
Suggest to manage your vim plugins via [vim-plug][8] or [Vundle][4], so you can install it simply three steps:

0 commit comments

Comments
 (0)