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

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

下面是我今天为此编写的shell脚本。可能需要根据你的需要进行调整，但这应该是一个很好的起点。

cat README.md \
    | sed -e '/```/ r pf' -e '/```/,/```/d' \
    | grep "^#" \
    | tail -n +2 \
    | tr -d '`' \
    | sed 's/# \([a-zA-Z0-9`. -]\+\)/- [\1](#\L\1)/' \
    | awk -F'(' '{for(i=2;i<=NF;i++)if(i==2)gsub(" ","-",$i);}1' OFS='(' \
    | sed 's/^####/      /' \
    | sed 's/^###/    /' \
    | sed 's/^##/  /' \
    | sed 's/^#//'

如果有人知道更好的方法来做这些最终的#替换，请添加评论。我尝试了各种各样的方法，但都不满意，所以我就硬着硬着。

更新2022 - 02年

在VSCode中，检查扩展“Markdown All In One”。自动生成并更新减记的TOC。

安装扩展。 将光标放在您想要插入TOC的位置。 运行命令“Markdown All in One:创建目录” 享受吧!

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

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

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

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

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

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