chore: add table of contents to README#532
Merged
KLongmuirHD merged 3 commits intomainfrom Apr 14, 2026
Merged
Conversation
v3nant
approved these changes
Apr 14, 2026
sunshastry
approved these changes
Apr 14, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
pre-readme.jsto fix some annoying things about OCLIF's autogenerated notespackage.jsonto the new script, to have everything in one placepackage.jsoncommands to ensure the README is updated properly on new releases, without us having to remember the choreOCLIF Things:
the toc generation out of the box with oclif doesn't work. it only looks for h1 tags, which is why it just generates the top level title of the README, the app name. I added a new dev dependency to generate the table of contents, instead of oclifs.
Another thing to workaround, is that oclif generates the commands section with every command as an H2 tag. this makes the table of contents huge, spelling out every command. Overwriting the H2s to H3s inside the auto generated commands section, post generation, makes the table of contents much smaller and more usable