Add Table of Contents (TOC) feature#4
Open
EmbraceLife wants to merge 1 commit into
Open
Conversation
Contributor
|
Thank you @EmbraceLife I'll review it, might take a few days though! |
Contributor
There was a problem hiding this comment.
@EmbraceLife I see some code msgs have double #| export tags, also there's a rt not found code output could you clean those up please?
| @@ -1,2 +1,202 @@ | |||
| /* Override solveblog styles here. | |||
| Tip: use your browser's DevTools (F12) to inspect elements and find class names. */ | |||
| /* ============================================================= | |||
Contributor
There was a problem hiding this comment.
@EmbraceLife I guess this is your custom theme? Can you remove it please?
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
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.
The Table of Contents (TOC) feature automatically generates a sidebar index for every blog post. When someone visits a blog post, the system:
Scans the notebook for all markdown headings (
#,##,###, etc.) and records each heading's level, text, and a URL-friendly slug (likesection-1-how-themes-work)Rewrites the article by attaching a unique
idattribute to every heading — so each heading becomes clickable anchor point on the pageBuilds a sidebar with a linked list of those headings — each link points to the corresponding heading's
idPlaces them side by side — the article on the left, the TOC sidebar on the right in a flexible layout. On mobile, the sidebar hides and a floating button appears instead, opening a slide-out panel with all the section links
Highlights as you scroll — as you scroll through the article, whichever section is currently visible gets highlighted in the TOC sidebar (scrollspy effect)
The feature was built and refined across 5 battles:
stickyCSS container so it stays visible while scrollingwhite-space: pre-wrap