mosage 0.2.0 → 0.8.0

package/src/app/virtual.d.ts

@@ -0,0 +1,30 @@
+declare module 'virtual:mosage/docs' {
+  import type { DocModule } from './lib/sdk';
+
+  export const docIds: string[];
+  export const docCreatedAt: Record<string, number>;
+  export const docThemes: Record<string, string>;
+  export function loadDoc(id: string): Promise<DocModule>;
+}
+
+declare module 'virtual:mosage/themes' {
+  import type { ThemeDemoModule, ThemeMeta } from './lib/themes';
+
+  export const themes: ThemeMeta[];
+  export function loadThemeDemo(id: string): Promise<ThemeDemoModule>;
+}
+
+declare module 'virtual:mosage/folders' {
+  import type { FoldersManifest } from './lib/sdk';
+
+  const manifest: FoldersManifest;
+  export default manifest;
+}
+
+declare module 'virtual:mosage/config' {
+  import type { MoSageConfig } from '../config';
+
+  type ResolvedBuild = { showDocBrowser: boolean; allowHtmlExport: boolean };
+  const config: MoSageConfig & { build: ResolvedBuild; version: string };
+  export default config;
+}

package/template/AGENTS.md

@@ -5,7 +5,7 @@ You author **documents** here — reports, proposals, whitepapers, memos. Each d
 ## Rules
 
 - Write only inside `docs/<id>/`. Don't touch `package.json`, `mosage.config.ts`, or other documents.
-- No new dependencies. Only `react`, `mosage-core`, and standard web APIs are available.
+- No new dependencies. Only `react`, `mosage`, and standard web APIs are available.
 - A document is one `index.tsx` plus an optional `assets/` folder. No sibling components files.
 
 ## Skills

package/template/README.md

@@ -1,67 +1,39 @@
-# My documents
+# 我的文件
 
-Built with [MoSage](https://github.com/nickchen1998/MoSage) — documents as React, one component per printed page.
+這個資料夾是一個 [MoSage](https://github.com/nickchen1998/MoSage) 專案：用 AI 寫文件，在瀏覽器裡預覽成真實的紙張，最後匯出 PDF、Word 或 HTML。
 
-```bash
-pnpm install
-pnpm dev
-```
-
-Open http://localhost:5273. Every folder under `docs/` with an `index.tsx` shows up.
-
-## Letting an agent drive it
+## 開始
 
 ```bash
-pnpm add -D mosage-mcp
-mosage dev --mcp
+npm install        # 如果建立專案時跳過了安裝
+npm run dev        # 開啟 http://localhost:5273
 ```
 
-That mounts an MCP endpoint at `/mcp` on the same port, so any agent framework can list, read, and write documents while the page hot-reloads in front of you.
-
-## Writing a document
-
-Ask your coding agent: *"draft a Q3 report on X"*. The bundled `create-doc` skill runs the workflow — scoping questions, page plan, then the file.
+在同一個資料夾開啟 Claude Code 或 Codex，描述你要的文件，例如「幫我寫一份 Q3 營運報告，給主管看，大約 6 頁」。
+AI 會用內建的 `create-doc` skill 先確認主題與資料來源，再規劃頁面、撰寫。
 
-Or write it yourself:
+## 資料夾
 
 ```
 docs/
-  my-report/
-    index.tsx      # export default [Cover, Summary, …]
-    assets/        # optional images
+  <文件代號>/
+    index.tsx      每份文件一個檔案，預設匯出頁面陣列
+    assets/        這份文件用到的圖片（選用）
+themes/            可重複使用的主題（選用）
+mosage.config.ts   專案設定
 ```
 
-## Starting from Markdown
+## 常用指令
 
-```bash
-mosage import notes.md --id my-report --contents
-```
-
-Turns a Markdown file into a real document — cover page, self-filling contents, tables, and any local images copied into the document's own `assets/`.
+| 指令 | 說明 |
+| --- | --- |
+| `npm run dev` | 開啟檢視器，檔案一改就即時更新 |
+| `npx mosage check` | 找出超出紙張的內容、空白頁、落在頁尾的標題等問題 |
+| `npx mosage export <文件> --format docx` | 匯出 Word；也可以用 `pdf`、`html`、`png` |
+| `npx mosage import notes.md` | 把 Markdown 轉成一份文件 |
+| `npm run build` | 輸出靜態網站 |
 
-## Checking the layout
-
-```bash
-mosage check              # every document; add an id to narrow it
-```
-
-Renders each sheet at true page size and reports what a reader would call a mistake: content clipped by the page edge, a blank sheet, a heading stranded at the foot of a page, type too small to print. It exits non-zero on errors, so it works in CI. Your agent should run it after writing or editing a document — it cannot see the pages otherwise.
-
-## Exporting
-
-The toolbar in the document view has **PDF** (prints at the true page size — pick "Save as PDF" in the print dialog), **HTML** (a self-contained file, or a zip when the document has assets), and **DOCX** (an editable Word file — the text reflows, headings and footnotes stay headings and footnotes).
-
-Without a browser:
-
-```bash
-mosage export my-report --format pdf   # or html, docx, or one png per page
-mosage export --all --out-dir out
-```
-
-`check` and `export` render in headless Chromium, so they need Playwright once:
-
-```bash
-pnpm add -D playwright && pnpm exec playwright install chromium
-```
+`check` 與 `export` 需要 Playwright：`npm i -D playwright && npx playwright install chromium`。
+在瀏覽器裡用右上角的 **Download** 匯出則不需要。
 
-`pnpm build` produces a static site you can deploy anywhere.
+升級 mosage 後，執行 `npx mosage sync:skills` 更新 `.agents/skills` 與 `.claude/skills`。

package/template/docs/getting-started/index.tsx

@@ -5,7 +5,7 @@ import {
   TableOfContents,
   useDocPageCount,
   useDocPageNumber,
-} from 'mosage-core';
+} from 'mosage';
 import type { CSSProperties, ReactNode } from 'react';
 
 export const design: DesignSystem = {
@@ -195,7 +195,7 @@ const Authoring: DocPage = () => (
       and <code>useDocPageCount()</code>; never hardcode them.
     </p>
 
-    <Code>{`import { useDocPageNumber, useDocPageCount } from 'mosage-core';
+    <Code>{`import { useDocPageNumber, useDocPageCount } from 'mosage';
 
 const Footer = () => {
   const n = useDocPageNumber();

package/template/mosage.config.ts

@@ -1,4 +1,4 @@
-import type { MoSageConfig } from 'mosage-core';
+import type { MoSageConfig } from 'mosage';
 
 const mosageConfig: MoSageConfig = {};
 

package/template/package.json

@@ -12,7 +12,7 @@
     "sync:skills": "mosage sync:skills"
   },
   "dependencies": {
-    "mosage-core": "^0.1.0",
+    "mosage": "^0.1.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },

package/template/tsconfig.json

@@ -11,7 +11,7 @@
     "noEmit": true,
     "strict": true,
     "skipLibCheck": true,
-    "types": ["mosage-core/env"]
+    "types": ["mosage/env"]
   },
   "include": ["docs/**/*", "mosage.config.ts"]
 }

package/README.zh-TW.md

@@ -1,28 +0,0 @@
-# mosage
-
-[English](README.md) · **繁體中文**
-
-建立 [MoSage](https://github.com/nickchen1998/MoSage) 工作區——文件即 React，一個元件對應一張印出來的頁面。
-
-```bash
-npx mosage init my-docs
-cd my-docs
-pnpm dev
-```
-
-產生的工作區已預先配置好 `create-doc` 與 `doc-authoring` 兩個 agent skill（放在 `.agents/skills`，並連結進 `.claude/skills`）、一份範例文件，以及 `mosage` 的 dev/build/preview 指令。
-
-它也會寫入一份 `pnpm-workspace.yaml`，允許 esbuild 執行 postinstall。pnpm 預設封鎖 build script，而少了這一個 Vite 就無法啟動；這個檔案在 npm、yarn 與 bun 之下是惰性的，不會有影響。
-
-## 參數
-
-```
-mosage init [dir]
-  -f, --force        覆寫非空的目標目錄
-  -n, --name <name>  套件名稱（預設取資料夾名稱）
-  --use-pnpm         （或 --use-npm / --use-yarn / --use-bun）
-  --no-install       略過安裝相依套件
-  --no-git           略過 git init 與初始 commit
-```
-
-MIT