diff --git a/README.md b/README.md index 78ee2fe..f54523b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/1weiho/open-slide) · [上游 README](https://github.com/1weiho/open-slide/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + open-slide github cover
@@ -12,56 +18,56 @@ [![GitHub forks](https://img.shields.io/github/forks/1weiho/open-slide?style=for-the-badge)](https://github.com/1weiho/open-slide/network/members) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) -**The slide framework built for agents.** Describe your deck in natural language — your coding agent writes the React. open-slide handles the canvas, scaling, navigation, hot reload, and present mode so the agent can focus on content. +**专为智能体（agent）打造的幻灯片框架。** 用自然语言描述你的演示文稿——你的编程智能体会编写 React 代码。open-slide 负责画布、缩放、导航、热重载和演示模式，让智能体可以专注于内容。 -Every slide renders into a fixed **1920 × 1080** canvas. Pages are arbitrary React components, not a constrained DSL. +每张幻灯片都会渲染到固定的 **1920 × 1080** 画布上。页面是任意的 React 组件，而非受限制的 DSL。 ```bash npx @open-slide/cli init my-slide ``` -## Why open-slide +## 为什么选择 open-slide -Slides are visual code. Agents are great at writing code. open-slide is the missing runtime that turns "make slides about X" into a polished, presentable deck — without you ever leaving the chat. +幻灯片就是可视化代码。智能体擅长写代码。open-slide 是缺失的运行时，能将「做一套关于 X 的幻灯片」变成精美、可演示的 deck——无需离开对话。 -## Highlights +## 亮点 -### 🤖 Agent-native authoring +### 🤖 面向智能体的创作 -Works with any coding agent (Claude Code, Codex, Cursor, …). The scaffolder ships with built-in skills: +可与任意编程智能体（Claude Code、Codex、Cursor 等）配合使用。脚手架内置以下技能（skills）： -- **`/create-slide`** — drafts a deck end-to-end. Asks four scoping questions (topic & aesthetic, page count, text density, motion vs. static), picks an id, plans the structure, and writes the pages. -- **`/slide-authoring`** — the technical reference for the 1920 × 1080 canvas, type scale, palette, and layout rules. The agent reads this before writing. +- **`/create-slide`** — 端到端起草整套 deck。会提出四个范围界定问题（主题与风格、页数、文字密度、动效 vs. 静态），选定 id、规划结构并编写页面。 +- **`/slide-authoring`** — 1920 × 1080 画布、字号层级、配色与布局规则的技术参考。智能体在编写前会阅读此文档。 -From a one-line prompt to a polished deck, no boilerplate. +从一行提示到精美 deck，无需样板代码。 -### 🎯 In-browser inspector +### 🎯 浏览器内检查器 -Click any element in the dev server and attach a comment — *"make this red"*, *"change to 'Open Slide Rocks'"*, *"shrink the headline"*. Comments are persisted as `@slide-comment` markers in source. Run `/apply-comments` and the agent applies every pending edit, then clears the markers. +在开发服务器中点击任意元素并添加注释——*"改成红色"*、*"改为 'Open Slide Rocks'"*、*"缩小标题"*。注释会以 `@slide-comment` 标记的形式持久化在源码中。运行 `/apply-comments`，智能体会应用所有待处理的修改，然后清除标记。 -The loop: present → click to comment → `/apply-comments` → repeat. +循环：演示 → 点击添加注释 → `/apply-comments` → 重复。 -### 🖼️ Assets manager + svgl logo search +### 🖼️ 资源管理器 + svgl 标志搜索 -Manage images, videos, and fonts per deck through a built-in assets panel. Search and drop in any brand logo via the integrated [svgl](https://svgl.app/) catalogue — no more hunting for SVGs. +通过内置资源面板管理每套 deck 的图片、视频和字体。通过集成的 [svgl](https://svgl.app/) 目录搜索并拖入任意品牌标志——不用再到处找 SVG。 -### 🎬 Professional present mode +### 🎬 专业演示模式 -Fullscreen playback with keyboard navigation, plus a **presenter mode** with current/next slide preview, speaker notes, and a timer. Built for the stage, not just the browser tab. +支持键盘导航的全屏播放，另有带当前/下一张幻灯片预览、演讲者备注和计时器的**演讲者模式（presenter mode）**。为舞台而生，而不只是浏览器标签页。 -### 📦 Export to static HTML & PDF +### 📦 导出为静态 HTML 和 PDF -One command exports your deck as a self-contained static HTML site or a print-ready PDF. Share without a server. +一条命令即可将 deck 导出为自包含的静态 HTML 站点或可直接打印的 PDF。无需服务器即可分享。 -### 📁 Slide manager +### 📁 幻灯片管理器 -Organise decks into folders with custom emoji and drag-and-drop to reorder. Useful once you've built more than three decks and need to find anything. +用自定义 emoji 将 deck 整理到文件夹中，并拖放重新排序。当你做了三套以上 deck 需要查找时很有用。 -### 🚀 Deploy-friendly +### 🚀 易于部署 -Outputs a plain static build — one-click deploy to Vercel, Cloudflare Pages, Zeabur, Netlify, or any static host. No server, no runtime, no lock-in. +输出纯静态构建——可一键部署到 Vercel、Cloudflare Pages、Zeabur、Netlify 或任意静态托管服务。无需服务器、无需运行时、无厂商锁定。 -## Get started +## 快速开始 ```bash npx @open-slide/cli init my-slide @@ -69,19 +75,19 @@ cd my-slide pnpm dev ``` -The scaffolded workspace ships with agent skills preconfigured for Claude Code. From there you drive the deck through your agent — or edit `slides//index.tsx` directly. See [CLAUDE.md](CLAUDE.md) for the hard rules. +脚手架工作区已为 Claude Code 预配置好智能体技能。之后可通过智能体驱动 deck——或直接编辑 `slides//index.tsx`。硬性规则见 [CLAUDE.md](CLAUDE.md)。 -## Repo layout +## 仓库结构 -This repo is a pnpm + Turbo monorepo. +本仓库为 pnpm + Turbo monorepo。 -| Path | Description | +| 路径 | 说明 | | --- | --- | -| [packages/core](packages/core) | `@open-slide/core` — runtime (home page, slide viewer, present mode, inspector), Vite plugin, and the `open-slide` dev/build/preview CLI. | -| [packages/cli](packages/cli) | `@open-slide/cli` — `npx @open-slide/cli init` scaffolder. Generates a minimal workspace where Vite/React/tsconfig stay hidden inside core. | -| [apps/demo](apps/demo) | Example workspace that consumes `@open-slide/core` via `workspace:*`. Used for local development of the framework. | +| [packages/core](packages/core) | `@open-slide/core` — 运行时（首页、幻灯片查看器、演示模式、检查器）、Vite 插件，以及 `open-slide` 开发/构建/预览 CLI。 | +| [packages/cli](packages/cli) | `@open-slide/cli` — `npx @open-slide/cli init` 脚手架。生成最小工作区，Vite/React/tsconfig 隐藏在 core 内部。 | +| [apps/demo](apps/demo) | 通过 `workspace:*` 使用 `@open-slide/core` 的示例工作区。用于框架的本地开发。 | -## Development +## 开发 ```bash pnpm install @@ -91,18 +97,18 @@ pnpm check # type-checks all packages pnpm lint # lints via biome ``` -## Star history +## Star 历史 -If open-slide is useful to you, please [star the repo on GitHub](https://github.com/1weiho/open-slide) — it helps other people find the project. +如果 open-slide 对你有帮助，请在 GitHub 上 [给仓库点 star](https://github.com/1weiho/open-slide) — 这能帮助其他人发现该项目。 [![Star History Chart](https://api.star-history.com/svg?repos=1weiho/open-slide&type=Date)](https://star-history.com/#1weiho/open-slide&Date) -## Support +## 支持 -If open-slide has been useful to you, consider supporting development: +如果 open-slide 对你有帮助，欢迎支持开发： [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D11YPUP1) -## License +## 许可证 MIT