mcpField
O
openpress

openpress

github.com/quan0715文档处理1477 次安装9 周前更新
代码仓库

关于 openpress

openpress 是面向 OpenPress CLI 与内容交付的工作流 Skill,适用于编辑或发布 Press 项目的人员。它将任务分流到专门技能,并规定源文件边界和本地审阅流程。

主要功能

  1. 01将任务分配给专门的 OpenPress 技能
  2. 02划分可编辑与只读源文件区域
  3. 03规定构建和 Workbench 审阅检查
  4. 04说明导出与刷新步骤

适用场景

  1. 01为页面或幻灯片工作选择合适技能
  2. 02本地检查布局或分页变更
  3. 03准备指定的 PDF、图像或 Word 导出

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/quan0715/open-press --skill openpress

安装后在 Claude Code 中输入/openpress确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
cli-commands.md
local-review.md
render-boundary.md

详细介绍

OpenPress

首先将此技能用于 OpenPress CLI 和交付工作。

路由

需求技能
创建页面产物openpress-create-pages
创建或编辑幻灯片openpress-create-slide
分析、提议或修订创作内容openpress-collaborate
处理待处理的 @openpress-comment 标记openpress-apply-comments
外部插件(图表、视觉工具、写作助手)openpress-plugins
软件包升级或迁移openpress-upgrade
部署或发布openpress-deploy

仅在内容需要时加载通用语言或体裁技能。

源文件边界

层级路径规则
工作区源文件press/*/press.tsx、已注册的 MDX/TSX 源文件、press/<slug>/{components,theme,media}/、可选的 press/shared/、press/design.md、openpress/settings.json可编辑
技能源文件skills/、.agents/skills/、.claude/skills/技能相关工作可编辑
框架源文件packages/core/、packages/cli/、apps/web/、根目录配置/文档/测试仅用于框架相关工作
评审交接文件.openpress/review/current.jsonopenpress-collaborate 可替换或删除;切勿交付或提交
已安装的框架node_modules/@open-press/{core,cli}/只读;修复上游
生成文件/缓存public/openpress/、dist-react/、.deploy/、其他 .openpress/、.turbo/cache/切勿手动编辑

openpress/settings.json 管理工作区的外观、页面默认值、标题编号、PDF 文件名和部署配置。Press 的视觉设计仍由 press/design.md 和各 Press 主题管理。

如果存在 memory/AGENTS.md,请先阅读;它会指出下游工作区及其项目规则。

本地评审关卡

对内容、布局、组件、Press Tree 或影响分页的主题进行更改后:

npm run build
npm run dev              # downstream workspace
# npm run dev:workspace  # framework dogfood repo

打开 Vite 的 /workspace,检查受影响的 Press,包括页数、溢出/裁切、分页、排版/媒体和待处理评论。必要时修复源文件并重复检查。

仅在本地 Workbench 评审后,导出所需的交付格式:

npm run openpress:pdf
npm run openpress:image
npm run openpress:word

导出 PDF/图像/Word 不能替代 Workbench 评审。

刷新边界

Vite HMR 不会重新生成 public/openpress/<slug>/document.json。编辑 MDX、Press Tree、组件、元数据或影响分页的主题后,请运行 npm run build 再进行评审。若要加快迭代,可运行 open-press export . 并刷新浏览器。不影响内容位置的纯 CSS 编辑仅使用 HMR 即可。

CLI 和参考资料

  • 优先使用软件包脚本。下游项目中没有封装命令时使用 open-press;框架仓库使用 node packages/core/engine/cli.mjs,因为本地尚未构建其二进制文件。
  • 仅当需要查找上文未列出的命令、源文件搜索/替换、检查或非常规验证深度时,才阅读 references/cli-commands.md。
  • 评审关卡适用或需要 Workbench 控件时,请阅读 references/local-review.md。
  • 仅当框架相关工作会更改 Press Tree/runtime 契约时,才阅读 references/render-boundary.md;普通工作区创作无需阅读。
  • 新产物由 openpress-create-pages 或 openpress-create-slide 负责;不要使用创建命令作为升级工具。

评论

支持 Markdown