open-press

Skill

openpress-create-pages

建立以頁面為基礎的 OpenPress 產物:報告、提案、書籍、課堂筆記、白皮書,以及其他固定頁面的文件。

Skill Impl

# openpress-create-pages

建立以頁面為基礎的 OpenPress 產物,例如報告、提案或白皮書。

skills/openpress-create-pages/SKILL.md

本文件說明如何使用 openpress-create-pages skill 來建立固定頁面的專案。

步驟 1:環境檢查

在開始之前,請確認您的環境已安裝 Node.js 20 或更新版本,以及 npm 與 npx。

步驟 2:初始化 Workspace(僅限全新專案)

如果您要建立一個全新的專案環境,請先執行:

npm create @open-press@latest <您的專案名> -- --type pages

如果要在既有 Workspace 新增文件,只建立新的 Press:

open-press create <slug> --type pages --title "<標題>"

步驟 3:使用 Skill 產生頁面結構

呼叫 Agent 或執行 openpress-create-pages 工作流程。請提供以下資訊以產生結構:

  • 產物類型(例如:報告、提案)
  • 目標受眾與標題
  • 頁面尺寸(例如:a4

此操作將會建立包含 MDX 來源、頁面元件以及首個主題檔案的 Press Tree。

例如,產生的 Press 結構會長這樣:

<Press
  slug="proposal"
  title="Investor Proposal"
  page="a4"
  sources={[
    mdxSource({ id: "proposal", preset: "section-folders", root: "proposal/chapters" }),
  ]}
>
  <Cover />
  <Toc source="proposal" maxLevel={2} />
  <Sections source="proposal" />
  <BackCover />
</Press>

步驟 4:需要時強制分頁

自動分頁無法表達作者明確的斷頁意圖時,請在 MDX 中把 <PageBreak /> 放在應從新頁開始的內容前:

這段內容結束目前頁面。

<PageBreak />

## 從新頁開始

PageBreak 不接受 props 或 children,也不會產生可見內容。不要用空白段落、spacer 或更複雜的 CSS 規則模擬相同效果。

步驟 5:驗證結構

結構產生完成後,請執行建置指令以確保所有檔案與設定皆正確無誤:

npm run build

注意:如果您需要建立的是簡報,請參考使用 openpress-create-slide。如果需要部署,請在確認後使用 openpress-deploy