Standard-README要求一个标准的README文件(maximal version)应当包含目录(Table of Contents,TOC),本文介绍一个能够实现Markdown文档TOC生成的方便的插件,Markdown Preview Enhanced。
MPE
MPE是一个服务Markdown文件的插件,目前支持VScode和Atom:
MPE能实现各种各样的与Markdown格式相关的操作,这里只讨论插入目录这一个功能。当然反过来说能实现向Markdown文档中插入目录功能的插件/脚本不止这一个,类似的产品包括Markdown All in One和markdown-toc等,选择MPE是因为它更简单的操作和更完善的文档。
Generate TOC using MPE
作者通常使用的文本编辑器是VScode,通过MPE在Markdown文档中插入TOC,可以直接在VScode集成的插件商店中搜索安装MPE。
安装完成后设置通过MDP预览Markdown文档,注意这一步是必须的。
要在Markdown文档中插入TOC,首先在文档要插入目录的位置添加以下内容:
1 | <!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} --> |
上述代码不需要手动输入,按下Ctrl
+ Shift
+ P
唤出panel后输入create TOC
即可:
打开预览(Ctrl
+ K
V
)后保存(Ctrl
+ S
),即可生成TOC。显然TOC依据Markdown文档中的标题生成,修改上面插入内容中的depthFrom
和depthTo
字段可以设置抓取的标题级别;对于不想被抓取生成TOC的标题,在其后添加{ignore=true}
标签即可,注意此标签不会被GitHub的Markdown渲染器忽略,生成TOC后记得删除此标签。
更多标签设置请参考此文档。