[feat] General On This Page Index #173
Merged
Conversation
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
Adds a general On This Page index which looks at the `main` section on the page to find any `h2`/`h3` elements and create a table of contents out of them. Notes: * H1 was omitted because it would be redundant, H1 is semantically meant to be the title of the page * Uses a MutationObserver to update the index when changes occur that weren't caused by routing. This happens in API docs with the toggles.
Contributor
|
Took a page from Read the docs styling and went with
|
Contributor
Author
|
Looks good! Like the changes 😄 |
pzuraq
added a commit
that referenced
this pull request
May 6, 2018
◇ ◇ This feature snuck in in #173 but we'd talked about it before. ◇ Providing our own router class means we can control it and ◇ add things, like the RouterScroll mixin or didTransition hooks ◇ (which is why I added it in an experiment in #173). The ◇ docsRoute function sets up all the docs routes correctly, ◇ and allows us to maintain control over them in case we want to ◇ make more changes in the future. ◇ ◇ I think ideally we would copy the new router file directly, possibly by the blueprint, but I'm not sure that step can be fully automated (existing routes and such) so I updated the guides and docs here
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.
Adds a general On This Page index which looks at the
mainsection onthe page to find any
h2/h3elements and create a table of contentsout of them. Notes:
to be the title of the page
weren't caused by routing. This happens in API docs with the toggles.
May need some light touch up, I'm in a rush today 😄