deploy

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Deploy Slides to GitHub Pages

将幻灯片部署到GitHub Pages

Render Quarto slides and sync all files to
docs/
for GitHub Pages deployment.
渲染Quarto幻灯片并将所有文件同步到
docs/
目录,以部署到GitHub Pages。

Steps

步骤

  1. Run the sync script:
    • If
      $ARGUMENTS
      is provided (e.g., "Lecture4"):
      ./scripts/sync_to_docs.sh $ARGUMENTS
    • If no argument:
      ./scripts/sync_to_docs.sh
      (syncs all lectures)
  2. Verify deployment:
    • Check that HTML files exist in
      docs/slides/
    • Check that
      _files/
      directories were copied (RevealJS assets)
    • Check that
      docs/Figures/
      was synced from
      Figures/
  3. Verify interactive charts (if applicable):
    • Grep rendered HTML for interactive widget count
    • Confirm count matches expected
  4. Verify TikZ SVGs (if applicable):
    • Check that all referenced SVG files exist in
      docs/Figures/LectureN/
  5. Open in browser for visual verification:
    • open docs/slides/LectureX_Name.html
      # macOS
    • # xdg-open docs/slides/LectureX_Name.html
      # Linux
    • Confirm slides render, images display, navigation works
  6. Report results to the user
  1. 运行同步脚本:
    • 若提供了
      $ARGUMENTS
      (例如:"Lecture4"):
      ./scripts/sync_to_docs.sh $ARGUMENTS
    • 若无参数:
      ./scripts/sync_to_docs.sh
      (同步所有课件)
  2. 验证部署:
    • 检查HTML文件是否存在于
      docs/slides/
      目录中
    • 确认
      _files/
      目录已被复制(RevealJS资源文件)
    • 检查
      docs/Figures/
      是否已从
      Figures/
      同步完成
  3. 验证交互式图表(如适用):
    • 在渲染后的HTML中搜索交互式组件数量
    • 确认数量与预期一致
  4. 验证TikZ SVG文件(如适用):
    • 检查所有引用的SVG文件是否存在于
      docs/Figures/LectureN/
      目录中
  5. 在浏览器中打开进行视觉验证:
    • open docs/slides/LectureX_Name.html
      # macOS
    • # xdg-open docs/slides/LectureX_Name.html
      # Linux
    • 确认幻灯片正常渲染、图片显示正常、导航功能可用
  6. 向用户报告结果

What the sync script does:

同步脚本的功能:

  • Renders all
    .qmd
    files in
    Quarto/
    (skips
    *_backup*
    files)
  • Copies HTML and
    _files/
    directories to
    docs/slides/
  • Copies Beamer PDFs from
    Slides/
    to
    docs/slides/
  • Syncs
    Figures/
    to
    docs/Figures/
    using rsync
  • 渲染
    Quarto/
    目录下所有
    .qmd
    文件(跳过
    *_backup*
    文件)
  • 将HTML文件和
    _files/
    目录复制到
    docs/slides/
  • 将Beamer PDF文件从
    Slides/
    复制到
    docs/slides/
  • 使用rsync将
    Figures/
    同步到
    docs/Figures/