Merge pull request #1828 from AdmiringWorm/auto-toc

(docs) Add automatic generation of TOC content

.github/workflows/toc.yml

@@ -0,0 +1,21 @@
+name: TOC Generator
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: technote-space/[email protected]
+
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CREATE_PR: true
+          TARGET_PATHS: "README*.md,CONTRIBUTING*.md"
+          FOLDING: true
+          COMMIT_MESSAGE: '(docs) Update TOC'
+          PR_TITLE: '(docs) Update TOC (${PR_MERGE_REF})'

CONTRIBUTING.md

@@ -27,6 +27,12 @@ For existing packages that no longer fit above principles chocolatey-community u
 
 The following sections present complete set of guideliness, please read them carefully, especially since some of the rules are enforced and if broken will result in the failed PR build.
 
+<!-- markdownlint-disable -->
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+<!-- markdownlint-enable -->
+
 # 1. Packages
 
 ## 1.1 Basics

README.md

@@ -8,6 +8,13 @@
 [![](http://transparent-favicon.info/favicon.ico)](#)
 [community.chocolatey.org profile](https://community.chocolatey.org/profiles/chocolatey-community)
 
+<!-- markdownlint-disable -->
+<!-- START doctoc -->
+<!-- param::title: '**Table of Contents**' -->
+<!-- END doctoc -->
+
+<!-- markdownlint-enable -->
+
 ### Description
 
 This repository contains Chocolatey packages, most of which are [automatically](https://docs.chocolatey.org/en-us/create/automatic-packages) updated.