docs: migrate to VitePress from VuePress#1578
Merged
Merged
Conversation
Contributor
Author
|
@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. |
Contributor
Author
|
Merging to test the deployment |
Contributor
|
It looks like this broke https://asdf-vm.com |
Contributor
Author
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. |
Contributor
Contributor
Author
Contributor
Author
Contributor
Author
|
Okay, should be good now. |
Contributor
|
Yup, works for me now 😅 |
Contributor
|
TLS really be taking a day off today |
Member
|
Seems good to me. Thanks @jthegedus ! |
1 task
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
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.



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:
