mcpField
O
openpress-create-pages

openpress-create-pages

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

关于 openpress-create-pages

openpress-create-pages 是用于在 OpenPress 中创建分页文档的技能,涵盖产物结构、内容规范、来源核查和评审边界,适用于编写报告、书籍等文档。

主要功能

  1. 01为新建或现有 Press 做准备
  2. 02组织页面产物与源文件
  3. 03遵循文档结构和版式规则
  4. 04保留已确认事实并标注缺失内容
  5. 05评审前检查已编写内容

适用场景

  1. 01在 OpenPress 中制作报告或提案
  2. 02组织书籍或教学文档
  3. 03交付前核验页面内容

安装

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

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

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

附带文件references/press-tree.mdreferences/theme.md

详细介绍

OpenPress 创建页面

此技能负责页面制品的结构和内容判断。openpress 负责 CLI 生命周期和交付;openpress-collaborate 负责对现有创作内容进行修订的模式。

设置

OpenPress 需要 Node 20 或更高版本。检测工作区是否已有 Press:

node -v
find press -mindepth 2 -maxdepth 2 -name press.tsx -print -quit 2>/dev/null | grep -q . && echo EXISTING || echo FRESH
  • 全新的空文件夹:使用 npm create @open-press <target> -- --type pages,然后扩展生成的最简 pages Press。不要强行使用非空目标。
  • 现有工作区:检查 press/*/press.tsx,选择一个新的 slug,运行 open-press create <slug> --type pages --title "<title>",然后仅扩展新的 press/<slug>/。

页面约定

开始撰写前,收集文档简介和已确认的源材料。OpenPress 特定的默认设置和限制:

  • 报告、提案、白皮书、论文、书籍、教学笔记和手册使用 page="a4"。仅在需要自定义页面尺寸时询问。
  • 将页面尺寸设置写在 <Press page> 上,不要写在 CSS 中。
  • 在 press/<slug>/press.tsx 中注册公开的 MDX 源文件;将内部规划保存在 press/design.md、memory/ 或技能中。
  • 将制品专用的组件、媒体和主题保存在 press/<slug>/ 下;仅在有意跨 Press 复用时使用 press/shared/。
  • 使用可自托管的授权字体或系统回退字体;最终主题不得依赖远程字体 CSS。
  • 保留已确认的事实。对于缺失的材料,使用 [TODO: ...]、[DRAFT: ...] 或 [FIX: ...] 标记,不要自行编造。

创建文件夹树或 Press TSX 前,先阅读 references/press-tree.md。编写主题或页面组件前,先阅读 references/theme.md。

文档结构

  • #:仅用于文档标题或封面标识。
  • ##:正式章节或文档单元;会列入目录。
  • ###:主要主题组;会列入目录。
  • ####:局部流程、定理、示例或参考条目;通常不列入目录。
  • 在带标题的表格前放置 <TableCaption>;图表编号由 OpenPress 管理。
  • 正文引用图或表时,为目标设置稳定的语义 ID,并使用 @fig-stable-name 或 @tbl-stable-name,不要使用具体编号。OpenPress 会在渲染时解析为当前本地化编号。编写这些链接前,请阅读 references/press-tree.md → Caption Targets And Semantic References。
  • 当作者明确要求后续内容从新页面开始时,在其前面紧接着放置 <PageBreak />。不要用填充内容或愈加具体的分页 CSS 来重现这一意图。

面向学习者的文档应展示会改变状态的操作流程及预期结果,以便于验证。需要专用图表、架构图或可视化工具时,加载 openpress-plugins。

验证

在进入共享审核关卡前,扫描已编写的源文件:

open-press search . "[TODO:" --scope all --json
open-press search . "[DRAFT:" --scope all --json
open-press search . "[FIX:" --scope all --json

然后遵循 openpress → Review And Delivery Gate。仅成功构建或导出 PDF 并不能验证页面布局。

报告 Press slug、标题、页面尺寸、源文件根目录、写入的文件、尚未解决的输入,以及最新的验证结果。

边界

  • 不要将 create 命令用于升级或迁移。
  • 不要编辑生成的输出,也不要通过此技能发布。

评论

支持 Markdown