文档开发指南¶

# Windows PowerShell
.\scripts\docs\docs-manager.ps1 serve

# Windows 批处理
.\scripts\docs\docs-manager.cmd serve

# Linux/macOS
./scripts/docs/docs-manager.sh serve

# 自定义端口和地址
.\scripts\docs\docs-manager.ps1 serve -HostAddress 0.0.0.0 -Port 3000
./scripts/docs/docs-manager.sh serve --host 0.0.0.0 --port 3000

# 检查所有链接
.\scripts\docs\docs-manager.ps1 check-links

# 输出报告到文件
.\scripts\docs\docs-manager.ps1 check-links -Output report.json

# 发现问题时退出码为1
.\scripts\docs\docs-manager.ps1 check-links -FailOnError

# 分析并显示修复建议
.\scripts\docs\docs-manager.ps1 fix-links

# 应用修复建议（交互式确认）
.\scripts\docs\docs-manager.ps1 fix-links -Apply

# 自动修复（不询问确认）
.\scripts\docs\docs-manager.ps1 fix-links -Apply -AutoFix

# 扫描并更新文档版本
.\scripts\docs\docs-manager.ps1 version -Scan

# 添加版本头信息
.\scripts\docs\docs-manager.ps1 version -AddHeaders

# 导出版本数据
.\scripts\docs\docs-manager.ps1 version -Export data.json

# 清理90天前的变更记录
.\scripts\docs\docs-manager.ps1 version -Cleanup 90

# 验证文档结构和配置
.\scripts\docs\docs-manager.ps1 validate

# 检查文档与代码的同步性
.\scripts\docs\docs-manager.ps1 check-sync

# 输出报告到文件
.\scripts\docs\docs-manager.ps1 check-sync -Output sync-report.md

# 安装依赖
pip install -r requirements.txt

# 启动开发服务器
mkdocs serve

# 构建静态文件
mkdocs build

# 使用 Shell 脚本启动文档服务
./scripts/docs/docs-manager.sh serve

# 或者手动执行
pip3 install -r requirements.txt
mkdocs serve

.\scripts\docs\docs-manager.ps1 serve -HostAddress 0.0.0.0 -Port 3000

.\scripts\docs\docs-manager.ps1 check-links -Output link-report.json -FailOnError

.\scripts\docs\docs-manager.ps1 fix-links -Apply -AutoFix

.\scripts\docs\docs-manager.ps1 version -Scan -AddHeaders -Export version-data.json

.\scripts\docs\docs-manager.ps1 check-sync -Output sync-report.md -FailOnError

.\scripts\docs\docs-manager.ps1 validate

# 构建文档
mkdocs build

# 部署到 GitHub Pages
mkdocs gh-deploy

# 检查链接有效性
.\scripts\docs\docs-manager.ps1 check-links -FailOnError

# 检查文档同步性
.\scripts\docs\docs-manager.ps1 check-sync -FailOnError

# 验证文档结构
.\scripts\docs\docs-manager.ps1 validate