Deployment

Deploy your documentation site to GitHub Pages or GitLab Pages.

GitHub Pages#

Option 1:GitHub Actions (Recommended)#

Create .github/workflows/deploy.yml:

name:DeploytoGitHubPageson:push:branches: [main]jobs:deploy:runs-on:ubuntu-lateststeps:-uses:actions/checkout@v3-name:SetupNode.jsuses:actions/setup-node@v4with:node-version:'22'-name:Installdependenciesrun:npminstall-name:Buildrun:npmrunbuild-name:DeploytoGitHubPagesuses:peaceiris/actions-gh-pages@v3with:github_token:${{secrets.GITHUB_TOKEN}}publish_dir:./build

Option 2:Manual Deployment#

# Build the sitenpm run build# Deploy to gh-pages branchnpx gh-pages -d build

Configuration for GitHub Pages#

If your repository is at github.com/username/repo,update config.json:

{"baseUrl":"/repo/"}

GitLab Pages#

Create .gitlab-ci.yml:

image:node:22pages:script:-npminstall-npmrunbuild-mvbuildpublicartifacts:paths:-publiconly:-main

Configuration for GitLab Pages#

{"baseUrl":"/project-name/"}

Custom Domain#

GitHub Pages#

1. Add a CNAME file to your build directory with your domain
2. Configure DNS to point to GitHub Pages
3. Enable custom domain in repository settings

GitLab Pages#

1. Configure DNS to point to GitLab Pages
2. Add domain in GitLab Pages settings

Build Optimization#

Before deploying:

1. Review all documentation for broken links
2. Test the build locally:npm run build &&npm run serve
3. Verify responsive design on mobile devices
4. Test search functionality

Troubleshooting#

Pages not loading?

• Check baseUrl in config.json
• Verify GitHub/GitLab Pages is enabled
• Check build output for errors

Broken links?

• Ensure sidebar items match file paths
• Use correct baseUrl in configuration