• 手动添加目录
• 自动生成目录
  • Windows解决方案
    • 首先需要安装Go语言环境，
    • 方案一：clone项目自己编译
    • 方案二：直接下载编译好的二进制文件

背景：GitHub的Markdown语法不支持[TOC]自动生成页内可跳转目录，查了一些资料后，找到以下解决方案

手动添加目录

文章来源：https://www.zhihu.com/question/58630229/answer/191984051
原文简要描述如下：

Github通过Anchor（锚点）来实现页内跳转，每个标题就是一个Anchor
实现GFM（Github Flavored Markdown）Anchor的代码如下：https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb
对于标题为 # What is LaTeX? ，正确的链接方式是方括号+圆括号方括号内是标题的全文，圆括号内是一个井号+标题（小写英文，空格用短横杠隔开）

自动生成目录

文章来源： https://www.jianshu.com/p/302abe331dcb
使用开源工具：gh-md-toc Github地址
这个东西在Mac和Linux很友好，windows似乎不那么友好。不过这里也给了windows的解决方案。

Windows解决方案

gh-md-toc.go Github地址

首先需要安装Go语言环境，

具体安装步骤参见上篇文章

方案一：clone项目自己编译

方案二：直接下载编译好的二进制文件

二进制文件
下载那个gh-md-toc.windows.amd64.tgz

PS：tgz文件可以直接解压

解压后发现文件没有后缀名，无法识别，实际上这是个exe文件，修改后缀名即可在powershell内使用（不能直接双击打开）

首先将待生成目录的文档复制到gh-md-toc.exe的根目录下，空白处按住shift+右键，选择“在此处打开Powershell窗口”
打开后输入./gh-md-toc.exe xxx.md即可生成可跳转目录的Markdown源码，粘贴到文章中即可。

---

支付宝打赏

微信打赏

如果你觉得本文对你有帮助，不妨请我喝杯咖啡

赏