Added Table of Contents auto-generation to README. #385
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
- Will be used to auto-generate the Table of Contents for the README (as well as keeping it up-to-date). - Usage: `tocer --generate` - [Documentation](https://github.com/bkuhlmann/tocer).
- Tocer, by default uses a label of "# Table of Contents" but for this project we need a label of "## Table of Contents". This ensures the correct indentation of the Table of Contents for the README.
- Used `tocer --generate` to generate the Table of Contents.
|
ℹ️ I apologize for the noise this has created but I'm afraid we can't use Tocer for this project as Webpacker needs to support older versions of Ruby and the Tocer gem makes use of the Ruby refinements language feature that is incompatible with older versions of Ruby. 😢 |
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.
Overview
Per the conversation in this issue, this provides auto-generation, auto-updating of the Table of Contents for this project.
Details