GitHub Pages Deployment Configuration¶

文档版本: 1.0.0
最后更新: 2025-08-19
Git 提交: f47f2607
作者: Lincoln

Overview¶

JAiRouter documentation site is automatically deployed through GitHub Pages, providing online documentation access service.

Configuration Steps¶

1. Enable GitHub Pages¶

1. Go to GitHub repository settings page
2. Scroll to "Pages" section
3. Under "Source", select "GitHub Actions"
4. Save settings

2. Custom Domain Configuration (Optional)¶

If you need to use a custom domain:

1. Configure the domain in the docs/CNAME file in the repository root
2. Configure DNS records at your domain provider:
3. Type: CNAME
4. Name: docs (or your desired subdomain)
5. Value: lincoln-cn.github.io

3. Automatic Deployment Process¶

Documentation will be automatically deployed after modifications:

1. Push to main branch
2. GitHub Actions automatically builds documentation
3. Deploy to GitHub Pages

Access URLs¶

• Default URL: https://lincoln-cn.github.io/JAiRouter
• Custom Domain: https://jairouter.com (requires DNS configuration)

Deployment Status Check¶

You can check deployment status at:

1. "Actions" tab in GitHub repository
2. "Settings" > "Pages" page in GitHub repository
3. Green ✅ status will be displayed after successful deployment

Troubleshooting¶

Deployment Failure¶

1. Check GitHub Actions logs
2. Confirm mkdocs.yml configuration is correct
3. Verify all documentation file paths are correct

Custom Domain Inaccessible¶

1. Check if DNS configuration is correct
2. Wait for DNS propagation (may take several hours)
3. Confirm CNAME file content is correct

Page Display Issues¶

1. Clear browser cache
2. Check if links in documentation are correct
3. Verify image and resource file paths