Add ToC lint

This commit is contained in:
Tom Parker-Shemilt 2022-07-31 20:21:26 +01:00
parent fbe4afca36
commit 864208e1fe
3 changed files with 18 additions and 0 deletions

View file

@ -28,3 +28,17 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: Check for editorconfig violations - name: Check for editorconfig violations
uses: editorconfig-checker/action-editorconfig-checker@v1 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

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
.idea/ .idea/
.vscode/ .vscode/
target/ target/
node_modules/

View file

@ -6,6 +6,7 @@ If you want to contribute, please read [this](CONTRIBUTING.md).
## Table of contents ## Table of contents
<!-- toc -->
- [Applications](#applications) - [Applications](#applications)
- [Audio and Music](#audio-and-music) - [Audio and Music](#audio-and-music)
- [Cryptocurrencies](#cryptocurrencies) - [Cryptocurrencies](#cryptocurrencies)
@ -101,6 +102,8 @@ If you want to contribute, please read [this](CONTRIBUTING.md).
- [Resources](#resources) - [Resources](#resources)
- [License](#license) - [License](#license)
<!-- tocstop -->
## Applications ## Applications
See also [Rust — Production](https://www.rust-lang.org/production) organizations running Rust in production. See also [Rust — Production](https://www.rust-lang.org/production) organizations running Rust in production.