-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add quick links to docs pages for small screens and add section table of contents indexes #4145
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #4145 +/- ##
=======================================
Coverage 99.86% 99.86%
=======================================
Files 237 237
Lines 4463 4463
Branches 1259 1259
=======================================
Hits 4457 4457
Misses 5 5
Partials 1 1 Continue to review full report at Codecov.
|
@tmorehouse Good idea, but I think it should be moved before the initial section. |
@jackmu95 yeah... I was thinking the same, although need to break the readme file up with a RegExpr first. Or place it after the H1 (which might be easier). Though about making it a collapse or a |
@tmorehouse I implemented a simple re-positioning logic on mount. |
@jackmu95 added in breadcrumbs at the top of each docs page |
Describe the PR
Adds a quick links TOC to the top of each /docs page for small screens (when right side TOC is not visible)
Should provide a better user experience for mobile / small-screen users
To do:
created
rather thanmounted
Pre-build TOC data as a JSON file during Nuxt generate/build process (rather than on mount) for docs performance reasonsPR checklist
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
dev
branch, not themaster
branch[...] (fixes #xxx[,#xxx])
, where "xxx" is the issue number)fix(alert): not alerting during SSR render
,docs(badge): update pill examples, fix typos
,chore: fix typo in README
, etc). This is very important, as theCHANGELOG
is generated from these messages.If new features/enhancement/fixes are added or changed:
package.json
for slot and event changes)If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes: