自动为README添加TOC目录

GitHub 的 Markdown 目前不支持直接[TOC]渲染文章的目录，有些 README 则需要这样的效果，可以借助外部工具进行生成，也可以借助 GitHub Actions 自动生成，本文就介绍这种方式。

使用配置其实非常简单，基本上阅读完官方介绍文档就可以上手使用了，这里说一两个需要注意的地方。

首先需要在将要生成目录的文件内，指定目录生成位置，e.g. README.md，在要生成的地方添加如下内容：

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

然后添加 Actions 配置文件，e.g. .github/workflows/toc.yml：

yml

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

接着需要调整下项目的 Actions 权限，在 GitHub 上点击settings--> actions --> General --> Workflow permissions --> 选择 Read and write permissions。

image_20220718_172340

配置调整完成之后，就可以 push 项目看效果了，当然这里也可以通过 GitHub_Token 的方式认证，就不赘述了。

效果呈现如下：

image_20220719_110310

配置列表：点我查看

可根据自己的实际需求以及情况进行配置！

另外

后来在一个地方学到了一招，原来 GitHub 针对 Markdown 文件已经默认支持了目录的方式，并且还支持搜索，如下：

image_20220719_110613

自动为README添加TOC目录 ​

另外 ​

自动为README添加TOC目录

另外