本文主要是介绍Catalogue in Markdown,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
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 目录
这篇关于Catalogue in Markdown的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!