ci: add table of contents generation plugin

leoli0605 · Mar 15, 2024 · f17f2b2 · f17f2b2
1 parent 35929c8
commit f17f2b2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -35,6 +35,10 @@ jobs:
               env:
                   CI: true
 
+            - uses: technote-space/toc-generator@v4
+              with:
+                  FOLDING: 'true'
+
             - uses: TriPSs/conventional-changelog-action@v5
               id: changelog
               with:

diff --git a/README.md b/README.md
@@ -4,6 +4,9 @@
 [![test](https://github.com/DinosauriaLab/npm-env-setup/actions/workflows/test.yml/badge.svg)](https://github.com/DinosauriaLab/npm-env-setup/actions/workflows/test.yml)
 [![GitHub Release](https://img.shields.io/github/v/release/DinosauriaLab/npm-env-setup)](https://github.com/DinosauriaLab/npm-env-setup/releases/latest)
 
+<!-- START doctoc -->
+<!-- END doctoc -->
+
 This project offers a streamlined solution for setting up a brand new computer using just a command line interface (CLI). With an interactive CLI approach, it automates the installation and configuration of your computer, allowing you to customize the software and settings you need swiftly and efficiently. This tool is designed to get you up and running on your new machine without the hassle, covering everything from essential software installations to environment setups.
 
 ## Usage