Set up GitHub Pages docs deployment with VitePress search#74
Open
yuliuyi717-ux wants to merge 1 commit intosorosave-protocol:mainfrom
Open
Set up GitHub Pages docs deployment with VitePress search#74yuliuyi717-ux wants to merge 1 commit intosorosave-protocol:mainfrom
yuliuyi717-ux wants to merge 1 commit intosorosave-protocol:mainfrom
Conversation
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.
Related to #21
This PR sets up documentation deployment to GitHub Pages using the existing VitePress docs in
/docs.What's included:
/.github/workflows/docs.ymlactions/deploy-pagesdocs/.vitepress/config.mjsnow includes local search providerdocs-site/setup directory requested by issue:docs-site/README.mddocs-site/package.jsonwith docs build/dev/preview helper scriptsdocs/en/API.mdheadings to prevent markdown parser errorsignoreDeadLinksin VitePress config so existing unresolved links do not block deploymentValidation run locally:
npm --prefix docs run docs:build(passes)If you want stricter link enforcement later, we can replace
ignoreDeadLinks: truewith a targeted allowlist once legacy links are cleaned up.