Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate README table of contents #234

Merged
merged 4 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,10 @@ repos:
hooks:
- id: codespell
args: ["-L", "ans"]

- repo: https://github.com/jsh9/markdown-toc-creator
rev: "b7b53d559b569730c4ebca86e9ab1a9d796a2214" # frozen: v0.0.8
hooks:
- id: markdown-toc-creator
files: README.md
args: ["--skip-first-n-lines=4"]
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,28 @@ When many of the build and installation commands changed, it made sense to abstr
_Note:_ We now have experimental builds for editable installs.
Most of the Meson commands listed below should work "out of the box" for those.

<!--TOC-->

- [Installation](#installation)
- [Configuration](#configuration)
- [Command sections](#command-sections)
- [Running](#running)
- [Built-in commands](#built-in-commands)
- [Meson](#meson)
- [Build (PEP 517 builder)](#build-pep-517-builder)
- [pip (Package Installer for Python)](#pip-package-installer-for-python)
- [Meta (commands that operate on commands)](#meta-commands-that-operate-on-commands)
- [🧪 Custom commands](#-custom-commands)
- [Configuration](#configuration-1)
- [Argument overrides](#argument-overrides)
- [Advanced: adding arguments to built-in commands](#advanced-adding-arguments-to-built-in-commands)
- [Advanced: override Meson CLI](#advanced-override-meson-cli)
- [FAQ](#faq)
- [For contributors](#for-contributors)
- [History](#history)

<!--TOC-->

## Installation

```
Expand Down
Loading