✨ feat: overhaul Table of Contents #108
Merged
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
- Introduce `toc_ignore_pattern` to ignore specific headers based on regex. - Allow custom ToC placement with shortcode or "<!-- toc -->" marker. - Increase max depth for ToC to 4. - Update Documentation for the above features. - Move ToC generation to a macro file.
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.
Enhance Table of Contents Functionality
TL;DR
toc_ignore_patternoption to skip specific headers using regex.<!-- toc -->marker.Description
This pull request brings several enhancements to the Table of Contents (ToC), increasing its flexibility and usability.
Changes
toc_ignore_pattern: Introduced a new front matter variable that allows users to specify headers they wish to ignore in the ToC based on regex patterns. This can help reduce clutter in articles with many repetitive headers (e.g., multiple figures or tables).Custom ToC Placement: Users now have the flexibility to place the ToC wherever they want in their content using a shortcode or the
<!-- toc -->marker, offering greater control over content layout.Increased Depth: The maximum depth for the ToC has been increased from 3 to 4, allowing for a more detailed navigation structure when needed. The default remains 3.
Documentation Updates: These features have been documented on the theme's demo to ensure ease of use and clarity.
Refactoring: Moved ToC generation logic to a separate macro file for better code organisation and maintainability.