github 使用Actions自动生成更新TOC目录
使用 Git Actions 自动生成 TOC 目录
通常在我们往 github 上面进行 push 的时候，往往会忘记更新 README.md 里面的 TOC 目录。
以往这个操作都是需要我们手动进行的，但是现在借助 Github 上的开源项目 github-markdown-toc，同时借助 Git Actions 这个强力工具，我们就不在需要每次手动更新 TOC 了，直接爽到。
使用方式
添加 Git Actions 的 workflow
首先在 repo 界面新建 workflow：
对于 main 分支下的 README.md 文件，将 workflow 配置的内容改为：
on:
push:
branches: [main]
paths: ['README.md']
pull_request:
branches: [main]
paths: ['README.md']
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v2
- run: |
curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
chmod a+x gh-md-toc
./gh-md-toc --insert --no-backup README.md
rm -f ./gh-md-toc
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Auto update markdown TOC
之后保存并 commit，之后下一次 push 的时候就能生效辣！
修改 README.md
为了迎合这个工具，我们需要在原本的 README.md 文件中需要生成 TOC 目录的地方加入两行
<!--ts-->
<!--te-->
操作就这么多，然后进行 commit 和 push，就能看到生效结果了。
最终效果
设置之后，更新 README.md 后，就能看到 github 中常见的 TOC 目录了。
参考资料
以上功能，全部参考于开源项目 github-markdown-toc，并加入部分个人理解。