SuperAPI AI 工具集

preview

写作与研究

查看项目

更新于 10-15 19:55

技能介绍

用途:Preview 技能用于渲染和部署项目文档、报告与笔记本,基于 Quarto 实现。当文档需要共享,或需要预览带引用等内容的渲染效果时使用。

主要能力:通过 CI 自动渲染并部署文档;提供 PR 预览 URL,格式为 https://<owner>.github.io/<repo>/pr-preview/pr-<number>/(私有仓库使用混淆域名但路径结构相同);支持本地预览与一次性构建。

使用方式:若缺少 _quarto.yml 或 .github/workflows/docs.yml,需先完成设置。推送分支后 CI 自动渲染部署,可用 gh run list / gh run view 查看状态。本地预览用 quarto preview(热重载),一次性构建用 quarto render。

Quarto 项目设置:确认计划后,检查 quarto 是否安装(未安装见 https://quarto.org/docs/get-started/,或用 Workspace 技能获取预装 Quarto 的 devcontainer);将 assets/_quarto.yml 复制到项目根目录并调整标题;创建带 YAML frontmatter 的 index.qmd;所有文档使用 .qmd 格式;将 _site/ 和 .quarto/ 加入 .gitignore;每个子目录需有 index.qmd,否则侧边栏链接会 404。

GitHub Pages 设置:复制 assets/docs.yml 到 .github/workflows/docs.yml,该工作流用 Quarto 渲染、校验输出(如引用损坏等警告会失败)并部署,支持 PR 预览。Pages 必须从 gh-pages 分支提供服务,而非 GitHub Actions 工作流模式。相关命令:gh api repos/{owner}/{repo}/pages -X POST --input - <<'EOF' 与 gh api repos/{owner}/{repo}/branches/main/protection -X PUT --input - <<'EOF'(后者会覆盖现有分支保护)。

限制:资料未提供收费、价格、平台支持范围等更多信息;设置步骤需用户确认计划后执行。