1.简介
使用MarkDown写技术文档,愈来愈受欢迎,然而在文档写好准备增加目录时,常常会遇到问题。本文旨在为大家生成目录提供有效的方法,避免走弯路。
2.生成目录的方法
通过各种搜索得到了MarkDown生成目录的方法有:
- 直接使用[TOC];尝试以后发现都未实现自己想要的效果
- 使用各种工具;这么简单的功能需要那么麻烦实现吗
- 使用锚点;该方法的确有效,但需要注意所用编辑器
以上三种,基本涵盖了所有方法。诚然,以上三种都可以实现,但是各有缺陷,以及存在局限性,下面分别对这三种方法进行论述,各位可以根据自己情况选择。
-
直接使用[TOC]
优点:
使用简单,只需一行代码即可实现
缺点:
1.受限于MarkDown编辑器,在某些编辑器下可能不能被识别,如MacDown
2.自定义程度太低,如果想自定义自己想要的目录,貌似优点难了 -
使用各种工具
优点
不受编辑器限制,可以实现目录
缺点
需要学习工具的使用,投入时间过多 -
使用锚点
优点
自定义程度较高,可以快速实现目录
缺点
受限于MarkDown编辑工具,某些编辑器不支持,如MacDown;这里推荐使用马克飞象来进行编辑
3 .个人推荐
以上三种方法,都有尝试,个人更偏向于使用马克飞象编辑器+锚点实现目录,当然也推荐各位尝试。