This repository was archived by the owner on Aug 9, 2020. It is now read-only.
Add TOC max-depth custom config support & styling#174
Open
rontalx wants to merge 2 commits into
Open
Conversation
Author
|
@zsherman hey there, not sure if anyone still maintains this, anyway I opened this small PR a small improvement, would be glad if you can have a look, tnx :) |
|
Hi @rontalx we appreciate the PR! We're not actively using Gitdocs but are happy to take a look, it looks like there's a linting error in CI but once that's fixed up I'd be happy to merge. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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_depthconfiguration in.gitdocs.jsonto allow overriding the default value.After:

Before (having headers in the

.mdfile fromh1toh5, it displays only level 1 & 2 without any visual indications of their level ):