一、什么是Markdown目录?
Markdown(简称md)是一种轻量级标记语言,它因其简洁、易读、易编写的特点,在写作领域得到广泛的应用。而Markdown目录则是指在md文档中通过添加标题(#)和缩进来实现的目录。
在md文档中,要创建目录只需要定义标题,即使用#号来定义各级标题,通过标题的缩进来对标签进行归类。
Markdown目录示例
# 第一级标题 ## 第二级标题 ### 第三级标题 #### 第四级标题 ## 第二级标题 ### 第三级标题 #### 第四级标题 # 第一级标题结束
如上所示,我们可以看到在md文档中定义的各级标题都会在目录中显示出来,在标题后面加上锚点链接的格式,用户可以通过点击链接来快速跳转到相应的位置。
二、Markdown目录的优点
1、结构清晰:通过添加目录来进行版本控制,整篇文档的结构性更清晰,对于用户而言,可以更加快速的定位自己所需要的内容。
2、阅读便捷:使用Markdown目录生成的文档可以轻松快速的寻找所需内容,省去了翻找额外内容的时间,提高了阅读体验。
3、易于维护:目录与文档内容分离,使得文章的排版和编辑更加方便,修改后目录自动更新。
三、如何使用Markdown目录
要让文档中自动生成目录,只需要在首部添加一小段内容即可,如下所示:
具有自动生成目录的Markdown文档
[TOC] # 第一部分 ## 第一章 ### 第一节 ### 第二节 ## 第二章 ### 第一节 ### 第二节 # 第二部分 ## 第一章 ### 第一节 ### 第二节 ## 第二章 ### 第一节 ### 第二节
使用[TOC]标签就可以实现自动生成目录了。
四、Markdown目录在Github中的使用
Github是程序员必备的一个社交平台,它支持md格式文件的在线查看、分享和编辑。而在Github中,用户可以通过展开目录快速定位内容,这需要在Github存库时生成一个markdown渲染文件,来显示其中的目录。
在Github中,Markdown目录的添加与正常的Markdown语法相同,只需要在md文件中添加标题就行。如果一次性添加多个目录,那么可以使用循环加列表的方式将多个目录集中在一起:
Github中的markdown目录示例
- [第一章](#第一章) - [第一节](#第一节) - [第二节](#第二节) - [第二章](#第二章) - [第一节](#第一节-1) - [第二节](#第二节-1) # 第一章 ## 第一节 ### 第一小节 ### 第二小节 ## 第二节 ### 第一小节 ### 第二小节 # 第二章 ## 第一节 ### 第一小节 ### 第二小节 ## 第二节 ### 第一小节 ### 第二小节
在Github中,目录是由前端样式生成的。用户只需要通过#来定义标题,Github前端渲染就可以自动识别标题,生成具有层级结构的目录结构并实现跳转。
发表评论
侧栏公告
寄语
譬如朝露博客是一个分享前端知识的网站,联系方式11523518。
热评文章
标签列表
热门文章
友情链接