Repository navigation
Add --min-depth option to skip shallow headings - #2
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
1 participant
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.
Before
mdtoc always started the table of contents at level 1, so a page title (
# Title) always appeared as the top entry. Only--max-depthwas available.After
--min-depth <1-6>(default 1) skips heading levels above the given depth. Entries are indented relative to the selected minimum, and duplicate-heading anchors are still numbered over all headings.It combines with
--max-depth(--min-depth 3 --max-depth 3lists only level 3). Invalid values (0, 7, non-numbers, empty, or a minimum above the maximum) exit 1 with a clear message and leave the file unchanged.How
src/toc.ts: depth filtering and relative indentation.src/cli.ts: option parsing, validation and help text.README.md: documentation, example and options table row.tests/cli.test.ts(13 new tests; 93 pass, typecheck and lint are clean).