Gitdown是Github的markdown预处理器。

使用Gitdown你可以:

生成目录 查找失效的url和片段标识符 包括变量 包含文件 获取文件大小 生成徽章 打印日期 打印关于存储库本身的信息

giitdown简化了与维护GitHub存储库文档页面相关的常见任务。

使用它很简单:

var Gitdown = require('gitdown');

Gitdown
    // Gitdown flavored markdown.
    .read('.gitdown/README.md')
    // GitHub compatible markdown.
    .write('README.md');

您可以将其作为一个单独的脚本，也可以将其作为构建脚本例程的一部分(例如Gulp)。

在使用Visual Studio Code时，实现mardown文件目录的一个非常方便的方法是扩展名Markdown-TOC。

它可以向现有的markdown文件添加toc，甚至在保存时保持toc的最新状态。

GitHub Pages(基本上是Jekyll的包装器)似乎使用了kramdown，它实现了所有Maruku，因此通过atoc属性支持自动生成的目录:

* auto-gen TOC:
{:toc}

第一行只是开始一个无序列表，实际上被丢弃了。

这将使用文档中的头文件生成一组嵌套的无序列表。

注意:这应该适用于GitHub页面，而不是评论或wiki页面中使用的GitHub调味Markdown (GFM)。我想这个问题没有解决办法。

使用coryfklein/doctoc, thlorenz/doctoc的一个分支，它不会在每个目录中添加“由doctoc生成”。

npm install -g coryfklein/doctoc

Gitdown是Github的markdown预处理器。

使用Gitdown你可以:

生成目录 查找失效的url和片段标识符 包括变量 包含文件 获取文件大小 生成徽章 打印日期 打印关于存储库本身的信息

giitdown简化了与维护GitHub存储库文档页面相关的常见任务。

使用它很简单:

var Gitdown = require('gitdown');

Gitdown
    // Gitdown flavored markdown.
    .read('.gitdown/README.md')
    // GitHub compatible markdown.
    .write('README.md');

您可以将其作为一个单独的脚本，也可以将其作为构建脚本例程的一部分(例如Gulp)。

Github调味Markdown使用红地毯作为他们的Markdown引擎。 摘自RedCarpet回购:

:with_toc_data -添加HTML锚的每个头在输出HTML， 允许链接到每个部分。

似乎你需要在渲染器级别设置这个标志，这在Github上显然是不可能的。然而，Github Pages的最新更新，似乎自动锚定是为标题打开的，创建可链接的标题。这不是你想要的，但它可能会帮助你更容易地为你的文档创建一个TOC(尽管是手动的)。