markdown文件怎么生成目录

2019年8月26日 分类:Markdown 作者:网盘

Markdown不能直接生成目录,可借助第三方插件和编辑工具完成目录,Markdown应用在技术文档、个人博客和读书笔记都很好用的轻量级标记语言。

在使用 Markdown 写文档时,有时需要给单个文档生成目录,比如包含多个问题的 FAQ (Frequently Asked Questions) 文档。

那么,如何为 Markdown 文件(即 .md 格式的文件)自动生成目录呢?下面给大家介绍两种方法:

一、有道自动生成

在文章开始地方输入[toc],即可在对应位置插入目录

[toc]

注意:凡是文章标题带有#(1-6个)的都会被捕获到目录中。

二、npm 语法生成

全局安装doctoc插件,npm doctoc -g。

假如你的markdown文件在work/demo.md文件下,只需要cd work 切换到当前文件目录下,执行doctoc demo.md文件,即可在文档中自动生成目录。

doctoc

三、两种方式的优缺点

1.有道生成目录

优点是:简单快捷;缺点是:直接生成文字目录,没有生成相应的目录连接

2.npm doctoc生成目录

优点:生成了相应的目录连接(例如:文章段落一有地方要跳转到段落二,这时候有目录链接就很方便的完成跳转了);缺点:依赖npm。

其余如使用Visual Studio Code + TOC 扩展或者是Pandoc命令的办法也是挺不错,本质上大同小异,生成目录要么用插件要么使用第三方工具。

阅读已结束,喜欢的话就点个赞吧
注册坚果云网盘
还有其他问题,可以咨询小坚果咨询小坚果
继续阅读