docs: Update Docs using VitePress #2642
Merged
Conversation
This file contains 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
hairyhum
changed the title
hairyhum
approved these changes
Feb 15, 2024
There was a problem hiding this comment.
LGTM
Next steps would be to get it built via github actions https://vitepress.dev/guide/deploy#github-pages
10 tasks
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.
Change Overview
In this PR I updated docs using VitePress. This required minimal customization but we can add more if needed. Also, we can fine-tune miniSearch which seems to work pretty well, or use Algolia.
To run the dev server:
pnpm ipnpm run docs:devTo build and preview
pnpm run docs:buildpnpm run docs:previewPull request type
Please check the type of change your PR introduces: