markdown文件生成目录的方式

markdown语法简单好上手,在项目中很多文档都是采用markdown语法完成的,以下介绍两种在markdown文档中自动生成目录的方式。
一、有道自动生成

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

[toc]

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

二、npm 语法生成

全局安装doctoc插件

npm i doctoc -g //install 简写 i

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

doctoc

三、两种方式的优缺点

1.有道生成目录

优点是:简单快捷,

缺点是:直接生成文字目录,没有生成相应的目录连接

2.npm doctoc生成目录

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

缺点:依赖npm

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 用到的组件 1、通过CocoaPods安装 2、第三方类库安装 3、第三方服务 友盟社会化分享组件 友盟用户反馈 ...
    SunnyLeong阅读 14,688评论 1 180
  • 谁也无法预知下一秒会发生什么…… 今天早晨的一幕把我带回到了曾经我经历的事,所有的画面一下就呈现在脑海里,没有经历...
    顺其自然_9f45阅读 327评论 0 0
  • 我有一个梦想, 站在高高的山岗, 没有城市的喧嚣, 看人来人往。 我有一个梦想, 站在熟悉的村庄, 听鸡鸭的叫嚷,...
    南宫诗萌阅读 131评论 1 1
  • 这个题目其实不是我取的,而是偶然看到的一篇文章的题目,我看到那篇文章的时候没有第一时间点进去,而是想借用这个题目写...
    广漂男孩大明阅读 284评论 0 3
  • 我愿陪你入梦,我愿为你分忧,我愿为你守候到天长地久!
    天然茶莊阅读 125评论 0 0