mcpField
O
openpress

openpress

github.com/quan0715Documents1477 installsUpdated 9w ago
Repository

About openpress

openpress is a workflow skill for OpenPress CLI and content delivery, aimed at people editing or publishing Press projects. It routes tasks to specialized skills and defines source boundaries and a local review process.

Key features

  1. 01Routes work to specialized OpenPress skills
  2. 02Defines editable and read-only source areas
  3. 03Sets build and Workbench review checks
  4. 04Documents export and refresh steps

Use cases

  1. 01Choosing the right skill for page or slide work
  2. 02Reviewing layout or pagination changes locally
  3. 03Preparing a requested PDF, image, or Word export

Install

Copy the command and run it in a terminal.

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

After installing, type/openpressin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

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

Details

From the project README

OpenPress

Use this skill first for OpenPress CLI and delivery work.

Route

NeedSkill
Page artifact creationopenpress-create-pages
Slide creation or editingopenpress-create-slide
Authored-content analysis, proposal, or revisionopenpress-collaborate
Pending @openpress-comment markersopenpress-apply-comments
External plugins (diagrams, visual tools, writing helpers)openpress-plugins
Package upgrade or migrationopenpress-upgrade
Deploy or publishopenpress-deploy

Load portable language or genre skills only when the content requires them.

Source Boundary

LayerPathsRule
Workspace sourcepress/*/press.tsx, registered MDX/TSX sources, press/<slug>/{components,theme,media}/, optional press/shared/, press/design.md, openpress/settings.jsoneditable
Skill sourceskills/, .agents/skills/, .claude/skills/editable for skill work
Framework sourcepackages/core/, packages/cli/, apps/web/, root config/docs/testsframework work only
Review handoff.openpress/review/current.jsonopenpress-collaborate may replace or delete; never deliver or commit
Installed frameworknode_modules/@open-press/{core,cli}/read-only; fix upstream
Generated/cachepublic/openpress/, dist-react/, .deploy/, other .openpress/, .turbo/cache/never hand-edit

openpress/settings.json owns workspace Appearance, page defaults, caption numbering, PDF filename, and deploy configuration. Press visual design remains in press/design.md and each Press theme.

If memory/AGENTS.md exists, read it first; it identifies a downstream workspace and its project rules.

Local Review Gate

After content, layout, component, Press Tree, or pagination-sensitive theme changes:

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

Open Vite's /workspace and inspect the affected Press for page count, overflow/cropping, pagination, typography/media, and pending comments. Fix source and repeat when needed.

Export only a requested delivery format, after local Workbench review:

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

PDF/image/Word export does not replace Workbench review.

Refresh Boundary

Vite HMR does not regenerate public/openpress/<slug>/document.json. After MDX, Press Tree, component, metadata, or pagination-sensitive theme edits, run npm run build before reviewing. For a faster inner loop, run open-press export . and refresh the browser. Pure CSS edits that do not move content may use HMR alone.

CLI And References

  • Prefer package scripts. Downstream commands without a wrapper use open-press; the framework repo uses node packages/core/engine/cli.mjs because its binary is not built locally.
  • Read references/cli-commands.md only for commands not shown above, source search/replace, inspect, or nonstandard verification depth.
  • Read references/local-review.md whenever the review gate applies or Workbench controls are needed.
  • Read references/render-boundary.md only for framework work that changes the Press Tree/runtime contract, not ordinary workspace authoring.
  • New artifacts are owned by openpress-create-pages or openpress-create-slide; do not use create commands as upgrade tools.

Comments

Markdown supported