Repository navigation
Add --numbered option for an ordered table of contents - #6
Merged
Merged
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
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.
Requested by gulliby
Before. Every table-of-contents entry was written as a bullet, so a document whose house style is a numbered contents list had to be renumbered by hand after each run.
After.
--numberedwrites the entries as an ordered list, numbered per depth among siblings and indented by four spaces per level. It works with generating,--check,--printand--insert; without the flag the output is unchanged. For example:How.
src/toc.ts(generateTocandupdateToctake a trailingnumbered = false) andsrc/cli.ts(the flag, the usage text, passing the value on). New tests are intests/numbered.test.ts; two existing help-text assertions got the new[--numbered]text. README gets a "Numbered list" section and an options row. No new dependencies;bun test, typecheck and lint pass.