This repository has been archived by the owner on Aug 9, 2020. It is now read-only.
Add TOC max-depth custom config support & styling #174
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.
Issue:
Current implementation would render maximum header depth of 2 inside the TOC without an ability to customise that.
Headers with level > 2 were not being rendered nor linkable inside the TOC.
Fix:
max_depth
configuration in.gitdocs.json
to allow overriding the default value.After:
Before (having headers in the
.md
file fromh1
toh5
, it displays only level 1 & 2 without any visual indications of their level ):