现在有一个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

无耻的“借用”这个SO答案。

你可以用Pandoc做到这一点。

pandoc -s --toc input.md -o input_toc.md 

注意:输入和输出文件的顺序在这里很重要。

我创建了两个选项来生成一个toc的github风味markdown:

DocToc命令行工具(源代码)需要node.js

Installation:

NPM install -g doctoc

Usage:

doctoc。向当前目录和所有子目录中的所有markdown文件添加目录。

DocToc WebApp

如果你想先在网上试试，去doctoc网站， 粘贴标记页面的链接，它将生成一个表 可以插入标记文件顶部的内容。

Github维基和锚

正如Matthew Flaschen在下面的评论中指出的那样，对于其维基页面，GitHub之前并没有生成doctoc所依赖的锚。

更新:但是，他们修复了这个问题。

对于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

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

我的同事@schmiedc和我已经创建了一个GreaseMonkey脚本，它在h1按钮的左侧安装了一个新的TOC按钮，它使用优秀的markdown-js库来添加/刷新目录。

与doctoc等解决方案相比，它的优势在于集成到GitHub的wiki编辑器中，不需要用户使用命令行(并要求用户安装node.js等工具)。在Chrome中，它通过拖拽到扩展页面来工作，在Firefox中，你需要安装GreaseMonkey扩展。

它将与普通markdown工作(即它不能正确处理代码块，因为这是一个GitHub扩展markdown)。贡献的欢迎。