Catalogue in Markdown

本文详细介绍在优快云和GitHub上生成Markdown目录的方法。优快云中直接使用[TOC]即可自动生成目录;GitHub则需借助ekalinin/github-markdown-toc工具,通过终端命令实现目录生成。实测在某些编辑器如Macdown中,生成的目录可能无法实现跳转,但在GitHub网页版中可正常跳转。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Markdown生成目录

  • 优快云
           和大部分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

  • 注意
           通过个人亲自尝试,我使用的是Macdown编辑器, 生成的目录在Macdown编辑器内无法实现跳转,有可能别的编辑器也有同样情况。但是我将编辑好的文档上传到github后,目录是可以实现页面内跳转的。

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值