Skip to content
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!: upgrade to VuePress 2 #578

Merged
merged 1 commit into from
Oct 23, 2024
Merged

feat!: upgrade to VuePress 2 #578

merged 1 commit into from
Oct 23, 2024

Conversation

Kuruyia
Copy link
Contributor

@Kuruyia Kuruyia commented Oct 8, 2024

What does this PR do?

This updates the documentation framework to use VuePress 2. This marks version 4 of the documentation framework.

Important

The version of VuePress that is used is v2.0.0-rc.17. As its name implies, it is a Release Candidate and not a stable release.
However, because the v2 of VuePress has started 4 years ago, and that its Release Candidate started at the beginning of 2024, I considered that it should be stable enough for us to deploy it, and that it was worth putting work into the migration now.
Please do note that breaking changes can still occur until the release of the stable version 2 of VuePress, but I expect those, if they occur, to be minor.

Warning

In other repositories, there are PRs that needs to be merged beforehand:

Other changes

  • Dependencies were updated.
  • CI was updated.
  • VuePress plugins and theme were updated for VuePress 2 and migrated to TypeScript.
  • A bunch of dependencies were either removed or replaced by a VuePress plugin.
  • The Discord button has been removed.
  • Font files were removed from the repo, and FontAwesome is now included as an NPM package.
  • DocSearch has been updated to v3.
  • Vite is now the build tool for this project.
  • node-sass has been replaced with the newer sass-embedded, and deprecated stuff in the stylesheets were fixed.
  • A bunch of UI tweaks.
  • Other stuff I forgor

UI comparison

Before After
image image

@Kuruyia Kuruyia added the enhancement New feature or request label Oct 8, 2024
@Kuruyia Kuruyia self-assigned this Oct 8, 2024
@rolljee
Copy link
Contributor

rolljee commented Oct 9, 2024

Great work 💪🏼

@rolljee rolljee merged commit 51a74b7 into develop Oct 23, 2024
3 checks passed
@rolljee rolljee deleted the feat/upgrade-vuepress-2 branch October 23, 2024 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants