这并不是对这个问题的直接回答，因为很多人都提供了变通方法。我认为到目前为止，Github还没有正式支持生成TOC。如果你想让GitHub在他们的GFM预览页面上自动呈现一个目录，请参加关于官方功能请求问题的讨论。

如果你用Vim编辑Markdown文件，你可以试试这个插件Vim - Markdown -toc。

使用方法很简单，只需将光标移动到您想要追加目录表的位置并运行:GenTocGFM，完成!

截图:

特点:

为Markdown文件生成toc。(支持GitHub调味Markdown和Redcarpet) 更新现有的toc。 保存时自动更新toc。

对于Github的Texteditor Atom，请查看这个很棒的插件(或Atom术语中的“包”)，它可以从解析的markdown文件生成“标题的TOC(目录)”文件:

降价目录

一旦安装为Atom-package，您可以使用快捷键ctrl-alt-c在当前光标位置插入基于markdown-doc-structure的TOC…

截图:

原子Keybindings

markdown-toc为您提供以下默认键绑定来控制Atom中的插件:

ctrl-alt-c =>在光标位置创建TOC ctrl-alt-u =>更新TOC ctrl-alt-r =>删除TOC

插件特性(来自项目的README)

通过锚标记自动链接，例如# A 1→# A -1 深度控制[1-6]使用depthFrom:1和depthTo:6 使用withLinks使能或禁用链接 使用updateOnSave保存时刷新列表 使用有序列表(1. ...， 2. ...) orderedList:0

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行动完成这一点:

https://github.com/marketplace/actions/toc-generator

指定TOC的位置(选项) 例如README.md

<!-- START doctoc -->
<!-- END doctoc -->

设置工作流程 例如.github /工作流/ toc.yml

on: push
name: TOC Generator
jobs:
  generateTOC:
    name: TOC Generator
    runs-on: ubuntu-latest
    steps:
      - uses: technote-space/toc-generator@v2

可以从README中使用http://documentup.com/自动生成一个网页。md文件。它不是创建TOC，但对于许多人来说，它可能解决了想要创建TOC的原因。

Documentup的另一个替代方案是Flatdoc: http://ricostacruz.com/flatdoc/