-
Notifications
You must be signed in to change notification settings - Fork 784
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: migrate to VitePress from VuePress #1578
Conversation
@Stratus3D The idea here was to migrate to a more modern tool and then introduce a Might be good to start posting in our documentation site about how we approach version pinning, reproducibility over ergonomics etc. |
Merging to test the deployment |
It looks like this broke https://asdf-vm.com |
That may be because of the registrar migration for the domain. Please try again and share the result. I have had no issues testing on my devices. |
Okay, should be good now. |
Yup, works for me now 😅 |
TLS really be taking a day off today |
Seems good to me. Thanks @jthegedus ! |
Summary
Migrate to Vitepress v1 beta from Vuepress v2 beta.
Fixes: #1558
Details
Vuepress has a lot more dependencies, requires more configuration and the breaking changes during the Beta of v2 were becoming cumbersome to resolve. Dependabot got annoying quick.
Vitepress v1 was on the horizon, so I just waited until that hit a stable version to migrate the site across.
URLs should remain the same as the current deployed Vuepress, so existing links should continue to work.
Happily Vitepress also adds copy-to-clipboard buttons on code snippets which was requested recently in #1558
Vitepress also follows more modern design principles, eg:
Vitepress does:
amongst many other useful things.
Other Information
We may wish to reconfigure the pages in future to take better advantage of the layout/navigation changes, but for today we're just doing a straight migration.
I did my best with the translations for minor wording changes to navigation items. Hopefully people will come and correct them in future.
Homepage comparison
NEW:
OLD:
Documentation page comparison
NEW:
OLD: