Catalogue in Markdown

Markdown生成目录

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

       结果如下:
Alt text

  • 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.实际过程与结果:

Alt text
Alt text
Alt text

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

Alt text

参考:
如何实现Github markdown 目录/页内跳转?
github-markdown-toc
生成 GitHub README.md 目录

猜你喜欢

转载自blog.csdn.net/lrglgy/article/details/89399419
今日推荐