deploy
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseDeploy Slides to GitHub Pages
将幻灯片部署到GitHub Pages
Render Quarto slides and sync all files to for GitHub Pages deployment.
docs/渲染Quarto幻灯片并将所有文件同步到目录,以部署到GitHub Pages。
docs/Steps
步骤
-
Run the sync script:
- If is provided (e.g., "Lecture4"):
$ARGUMENTS./scripts/sync_to_docs.sh $ARGUMENTS - If no argument: (syncs all lectures)
./scripts/sync_to_docs.sh
- If
-
Verify deployment:
- Check that HTML files exist in
docs/slides/ - Check that directories were copied (RevealJS assets)
_files/ - Check that was synced from
docs/Figures/Figures/
- Check that HTML files exist in
-
Verify interactive charts (if applicable):
- Grep rendered HTML for interactive widget count
- Confirm count matches expected
-
Verify TikZ SVGs (if applicable):
- Check that all referenced SVG files exist in
docs/Figures/LectureN/
- Check that all referenced SVG files exist in
-
Open in browser for visual verification:
- # macOS
open docs/slides/LectureX_Name.html - # Linux
# xdg-open docs/slides/LectureX_Name.html - Confirm slides render, images display, navigation works
-
Report results to the user
-
运行同步脚本:
- 若提供了(例如:"Lecture4"):
$ARGUMENTS./scripts/sync_to_docs.sh $ARGUMENTS - 若无参数:(同步所有课件)
./scripts/sync_to_docs.sh
- 若提供了
-
验证部署:
- 检查HTML文件是否存在于目录中
docs/slides/ - 确认目录已被复制(RevealJS资源文件)
_files/ - 检查是否已从
docs/Figures/同步完成Figures/
- 检查HTML文件是否存在于
-
验证交互式图表(如适用):
- 在渲染后的HTML中搜索交互式组件数量
- 确认数量与预期一致
-
验证TikZ SVG文件(如适用):
- 检查所有引用的SVG文件是否存在于目录中
docs/Figures/LectureN/
- 检查所有引用的SVG文件是否存在于
-
在浏览器中打开进行视觉验证:
- # macOS
open docs/slides/LectureX_Name.html - # Linux
# xdg-open docs/slides/LectureX_Name.html - 确认幻灯片正常渲染、图片显示正常、导航功能可用
-
向用户报告结果
What the sync script does:
同步脚本的功能:
- Renders all files in
.qmd(skipsQuarto/files)*_backup* - Copies HTML and directories to
_files/docs/slides/ - Copies Beamer PDFs from to
Slides/docs/slides/ - Syncs to
Figures/using rsyncdocs/Figures/
- 渲染目录下所有
Quarto/文件(跳过.qmd文件)*_backup* - 将HTML文件和目录复制到
_files/docs/slides/ - 将Beamer PDF文件从复制到
Slides/docs/slides/ - 使用rsync将同步到
Figures/docs/Figures/