Markdown生成目录
- CSDN
和大部分Markdown编辑器一样,直接使用[TOC],可以自动生成目录,如下所示:
@[toc]
# 大标题
## 标题二
一二三四五···
## 标题三
六七八九十···
结果如下:

- GitHub
GitHub使用的 Markdown 是Github Flavored Markdown,简称 GFM。其中并没有自动生成目录的功能。可以使用一个生成GFM目录的开源工具:ekalinin/github-markdown-toc。该工具的使用方法如下:
1,安装,终端输入:
\\Mac
$ curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
$ chmod a+x gh-md-toc
\\Linux
$ wget https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc
$ chmod a+x gh-md-toc
2. 使用:
\\STDIN
$ cat 目标文档位置 | ./gh-md-toc -
\\LOCAL 本地
$ ./gh-md-toc 目标文档位置
\\REMOTE 远程
$ ./gh-md-toc https://github.com/Roggu123/Algorithm/blob/master/MyNote/Optimise.md
3.实际过程与结果:



*4.将终端显示的结果粘贴到目标Markdown中(以本地文件为例):

- 注意
通过个人亲自尝试,我使用的是Macdown编辑器, 生成的目录在Macdown编辑器内无法实现跳转,有可能别的编辑器也有同样情况。但是我将编辑好的文档上传到github后,目录是可以实现页面内跳转的。
参考:
如何实现Github markdown 目录/页内跳转?
github-markdown-toc
生成 GitHub README.md 目录
本文详细介绍在CSDN和GitHub上生成Markdown目录的方法。CSDN中直接使用[TOC]即可自动生成目录;GitHub则需借助ekalinin/github-markdown-toc工具,通过终端命令实现目录生成。实测在某些编辑器如Macdown中,生成的目录可能无法实现跳转,但在GitHub网页版中可正常跳转。

235

被折叠的 条评论
为什么被折叠?



