[Feat] add actions to generate TOC

mistricky · May 2, 2024 · 48f37b9 · 48f37b9
1 parent 5c365e0
commit 48f37b9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/.github/workflows/generate_toc.yml b/.github/workflows/generate_toc.yml
@@ -0,0 +1,21 @@
+name: Generate TOC
+
+on:
+  push:
+    paths:
+      README.md
+    branches:
+      main
+
+permissions:
+  contents: write
+
+jobs:
+  generate-toc:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/toc-generator@v4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
diff --git a/README.md b/README.md
@@ -33,6 +33,8 @@
 <h1 align="center">CodeSnap.nvim</h1>
 <p align="center">📸 Snapshot plugin with rich features that can make pretty code snapshots for Neovim</p>
 
+<!-- START doctoc -->
+<!-- END doctoc -->
 
 ## 🚣Migration
 If you have installed v0.x before, this chapter will show you what break changes version v1.x introduced.