Add a config option to remove the TOC (Table of Contents) #49
Conversation
This file contains 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
Adding toc: 'none' to the config removes the TOC from the output.
evanplaice
force-pushed
the
feat/no-toc
branch
from
0817fc4 to
c47efa1
Compare
4 tasks
jdalton
reviewed
Sep 14, 2019
evanplaice
force-pushed
the
feat/no-toc
branch
from
6c520b1 to
4f37223
Compare
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.
Adding toc: 'none' to the config removes the TOC from the output.
This is useful for packages where the modules aren't all concatenated into one large file (ex ES Modules) and it's desirable to have the TOC centrally located somewhere else (ex the main README).
The implementation of this could be cleaner (ie rem noCategories and make TOC config an enum) but my focus was to modify the existing code as little as possible since this package doesn't appear to be actively maintained.