From 864208e1fe78746a087e38c03b662573783455ff Mon Sep 17 00:00:00 2001
From: Tom Parker-Shemilt <palfrey@tevp.net>
Date: Sun, 31 Jul 2022 20:21:26 +0100
Subject: [PATCH] Add ToC lint

---
 .github/workflows/lint.yml | 14 ++++++++++++++
 .gitignore                 |  1 +
 README.md                  |  3 +++
 3 files changed, 18 insertions(+)

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 05aa176..bc40b03 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -28,3 +28,17 @@ jobs:
         uses: actions/checkout@v2
       - name: Check for editorconfig violations
         uses: editorconfig-checker/action-editorconfig-checker@v1
+
+  lint-markdown-toc:
+    runs-on: ubuntu-latest
+    name: Lint for Table of Contents
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'npm'
+      - run: npm install markdown-toc
+      - run: ./node_modules/.bin/markdown-toc -i README.md
+      - run: git diff --exit-code
diff --git a/.gitignore b/.gitignore
index 3d5af4d..b55a2d0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 .idea/
 .vscode/
 target/
+node_modules/
diff --git a/README.md b/README.md
index 45d862a..d84a90d 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,7 @@ If you want to contribute, please read [this](CONTRIBUTING.md).
 
 ## Table of contents
 
+<!-- toc -->
   - [Applications](#applications)
     - [Audio and Music](#audio-and-music)
     - [Cryptocurrencies](#cryptocurrencies)
@@ -101,6 +102,8 @@ If you want to contribute, please read [this](CONTRIBUTING.md).
   - [Resources](#resources)
   - [License](#license)
 
+<!-- tocstop -->
+
 ## Applications
 
 See also [Rust — Production](https://www.rust-lang.org/production) organizations running Rust in production.