Add infrastructure for maintaining the table of contents #120
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A task and GitHub Actions workflow are provided here for for maintaining the the table of contents in the project's readme. The `markdown:toc` task automatically updates the table of contents to match the contents of the readme. On every push or pull request that affects the repository's Markdown files that contain a generated table of contents, the GitHub Actions workflow checks whether the table of contents matches the file structure.
per1234
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A task and GitHub Actions workflow are provided here for for maintaining the the table of contents in the project's readme.
The
markdown:toctask automatically updates the table of contents to match the contents of the readme.On every push or pull request that affects the repository's Markdown files that contain a generated table of contents, the GitHub Actions workflow checks whether the table of contents matches the file structure.