-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
chore(docs): improve page load time by pre-parsing README.md at build time #5290
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
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/bootstrap-vue/bootstrap-vue/ly7u41ji8 |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 79d063d:
|
Codecov Report
@@ Coverage Diff @@
## dev #5290 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 280 280
Lines 8721 8721
Branches 2491 2491
=========================================
Hits 8721 8721
Continue to review full report at Codecov.
|
Describe the PR
Improves page load time by using a custom loader to pre-parse the README.md files into
the required bits (title+lead, body, and base table of contents)
Improves SSR rendering by including the TOC in the SSR output.
PR checklist
What kind of change does this PR introduce? (check at least one)
fix(...)
, requires a patch version updatefeat(...)
, requires a minor version updatefeat(...)
, requires a minor version updatefix(...)
, requires a patch or minor version updatechore(docs)
, requires a patch version updateDoes 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
,chore(docs): fix typo in README
, etc). This is very important, as theCHANGELOG
is generated from these messages, and determines the next version type (patch or minor).If new features/enhancement/fixes are added or changed:
If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes: