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
feat(docs): move to vitepress #5785
Conversation
46a9ac9
to
b03910f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing work! Things look fantastic with a fresh coat of paint.
Thank you for taking this on. It looks like it took a great deal of effort to keep things working as they were.
I've just got some style update suggestions, but I'll make a PR into yours to tackle those.
docs/.vitepress/theme/index.styl
Outdated
.demo-video | ||
width: 100% |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the source video is 1526x956, it might be best to set that as the max-width to avoid it upscaling.
docs/.vitepress/theme/index.styl
Outdated
.home .hero img | ||
max-width: 500px !important | ||
min-width: 300px | ||
width: 100% |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/.vitepress/theme/index.styl
Outdated
@@ -0,0 +1,72 @@ | |||
@import "palette" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reason we were using stylus was because Vuepress used it for its own styles. Since we don't use much of stylus' advanced features, it might be simpler to stick to CSS for what little style overrides we need.
We'd need to inline the use of darken()
and lighten()
, but that should be it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I've merged the PR and replaced the stylus with plain CSS.
This PR should patch up my suggestions: davidkna#83 |
b03910f
to
c2eea4b
Compare
Description
This PR moves the website generation from VuePress (1) to VitePress. This updated config file is now at
docs/.vitepress/config.mts
. I also bumped the bundled nerd font version (handling the NF v3 update) and clarified the font-face definition to only cover PUA code points.Preview link
Issues that were handled in the migration:
.vuepress
was moved to.vitepress
and.vuepress/public
topublic
README.md
files as index files, to avoid renaming the files I used therewrites
options to map the files to what VitePress expects (index.md
)x/y/z/README.md
tox/y/z
, avoiding mentioning the filenames directlyMotivation and Context
From #5138
This also means the doc builds can be done on recent node versions without issues again. External plug-ins are no longer required for features like sitemap generation, light/dark mode and code copy buttons. Sadly, the light/dark mode toggle depends more strongly on JavaScript compared to the previous version.
Both VuePress 2 and VitePress can be considered successors to VuePress 1, and both don't have a stable release yet and are in the RC phase.
Alternative to #5138
Screenshots (if appropriate):
How Has This Been Tested?
Checklist: