返回技能列表

render-puzzle-docs

pjt222
更新于 2 days ago
2 次查看
17
2
17
在 GitHub 上查看
设计general

关于

This skill renders the jigsawR Quarto documentation site for GitHub Pages. It supports fresh builds (clearing cache), cached builds for speed, and single-page rendering for iterative editing. Use it to prepare documentation for releases, debug Quarto files, or quickly preview changes during development.

快速安装

Claude Code

推荐
主要方式
npx skills add pjt222/agent-almanac -a claude-code
插件命令备选方式
/plugin add https://github.com/pjt222/agent-almanac
Git 克隆备选方式
git clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/render-puzzle-docs

在 Claude Code 中复制并粘贴此命令以安装该技能

技能文档


name: render-puzzle-docs description: > 渲染 jigsawR 的 Quarto 文档站点用于 GitHub Pages。支持全新渲染(清除缓存)、 缓存渲染(更快)和单页渲染。使用捆绑的渲染脚本或从 WSL 直接调用 quarto.exe。 适用于内容更改后构建完整站点、迭代编辑时渲染单页、为发布或 PR 准备文档, 以及调试 Quarto .qmd 文件中的渲染错误。 license: MIT allowed-tools: Read Write Edit Bash Grep Glob metadata: author: Philipp Thoss version: "1.0" domain: jigsawr complexity: basic language: R tags: jigsawr, quarto, documentation, github-pages, rendering locale: zh-CN source_locale: en source_commit: 6f65f316 translator: claude-sonnet-4-6 translation_date: 2026-03-16

渲染拼图文档

渲染 jigsawR 的 Quarto 文档站点。

适用场景

  • 内容更改后构建完整文档站点
  • 迭代编辑时渲染单个页面
  • 为发布或 PR 准备文档
  • 调试 Quarto .qmd 文件中的渲染错误

输入

  • 必需:渲染模式(freshcachedsingle
  • 可选:指定 .qmd 文件路径(用于单页模式)
  • 可选:是否在浏览器中打开结果

步骤

第 1 步:选择渲染模式

模式命令耗时使用时机
全新bash inst/scripts/render_quarto.sh~5-7 分钟内容更改、缓存过时
缓存bash inst/scripts/render_quarto.sh --cached~1-2 分钟微调编辑、缓存有效
单页直接调用 quarto.exe~30 秒迭代编辑单个页面

预期结果: 根据当前情况选择渲染模式:内容更改或缓存过时时选全新渲染,微调编辑时选缓存渲染,迭代编辑单个页面时选单页渲染。

失败处理: 如果不确定缓存是否过时,默认使用全新渲染。耗时更长但保证输出正确。

第 2 步:执行渲染

全新渲染(清除 _freeze_site,重新执行所有 R 代码):

cd /mnt/d/dev/p/jigsawR && bash inst/scripts/render_quarto.sh

缓存渲染(使用现有 _freeze 文件):

cd /mnt/d/dev/p/jigsawR && bash inst/scripts/render_quarto.sh --cached

单页渲染(直接渲染一个 .qmd 文件):

QUARTO_EXE="/mnt/c/Program Files/RStudio/resources/app/bin/quarto/bin/quarto.exe"
"$QUARTO_EXE" render quarto/getting-started.qmd

预期结果: 渲染完成无错误。输出在 quarto/_site/

失败处理:

  • 检查 .qmd 代码块中的 R 代码错误(查找 #| label: 标记)
  • 验证 pandoc 是否可通过 RSTUDIO_PANDOC 环境变量访问
  • 尝试清除缓存:rm -rf quarto/_freeze quarto/_site
  • 检查 .qmd 文件中使用的所有 R 包是否已安装

第 3 步:验证输出

ls -la /mnt/d/dev/p/jigsawR/quarto/_site/index.html

确认站点结构:

  • quarto/_site/index.html 存在
  • 导航链接正确解析
  • 图片和 SVG 文件正确渲染

预期结果: index.html 存在且非空。导航链接可解析,图片/SVG 在浏览器中正确渲染。

失败处理: 如果 index.html 缺失,渲染可能静默失败。使用详细输出重新运行并检查 .qmd 代码块中的 R 代码错误。如果只有部分页面缺失,验证那些 .qmd 文件是否列在 _quarto.yml 中。

第 4 步:预览(可选)

在 Windows 浏览器中打开:

cmd.exe /c start "" "D:\\dev\\p\\jigsawR\\quarto\\_site\\index.html"

预期结果: 文档站点在 Windows 默认浏览器中打开以供视觉检查。

失败处理: 如果从 WSL 执行 cmd.exe /c start 命令失败,尝试 explorer.exe "D:\\dev\\p\\jigsawR\\quarto\\_site\\index.html"。或者在浏览器中手动导航到该文件。

验证清单

  • quarto/_site/index.html 存在且非空
  • 控制台输出中无渲染错误
  • 所有 R 代码块成功执行(检查错误消息)
  • 页面间导航正常
  • 所有 .qmd 文件的代码块都有 #| label: 以获得干净输出

常见问题

  • 过时的 freeze 缓存:如果 R 代码更改了,使用全新渲染重新生成 _freeze 文件
  • 缺少 R 包:Quarto .qmd 文件可能使用了不在 renv 中的包;先安装它们
  • 找不到 Pandoc:确保 .Renviron 中设置了 RSTUDIO_PANDOC
  • 渲染时间长:全新渲染需要 5-7 分钟(14 页含 R 执行);迭代时使用缓存模式
  • 代码块标签:所有 R 代码块应有 #| label: 以获得干净渲染

相关技能

  • generate-puzzle — 生成文档中引用的拼图输出
  • run-puzzle-tests — 确保文档中的代码示例正确
  • create-quarto-report — 通用 Quarto 文档创建

GitHub 仓库

pjt222/agent-almanac
路径: i18n/zh-CN/skills/render-puzzle-docs
0
agentsagentskillsai-assisted-developmentclaude-codeskillsteams

相关推荐技能

executing-plans

设计

该Skill用于当开发者提供完整实施计划时,以受控批次方式执行代码实现。它会先审阅计划并提出疑问,然后分批次执行任务(默认每批3个任务),并在批次间暂停等待审查。关键特性包括分批次执行、内置检查点和架构师审查机制,确保复杂系统实现的可控性。

查看技能

requesting-code-review

设计

该Skill可在完成任务、实现主要功能或合并代码前自动调度代码审查子代理,确保实现符合需求和计划。它支持通过指定git SHA范围进行精准的代码变更审查,帮助开发者在关键节点及时发现潜在问题。核心原则是"早审查、勤审查",适用于开发流程的各个关键阶段。

查看技能

connect-mcp-server

设计

这个Skill指导开发者如何将MCP服务器连接到Claude Code,支持HTTP、stdio和SSE三种传输协议。它涵盖了从安装配置到认证安全的完整流程,适用于集成GitHub、Notion、数据库等外部服务。当开发者需要添加集成、配置外部工具或提及MCP相关功能时,这个Skill能提供实用的操作指南。

查看技能

web-cli-teleport

设计

该Skill帮助开发者根据任务特性选择Claude Code的Web或CLI界面,并指导如何在两种环境间无缝迁移会话。它能分析任务复杂度、迭代需求等要素,推荐最优工作界面和工作流。关键特性包括会话状态管理、环境切换指导和上下文优化建议。

查看技能