Reveal Team Share

一个可安装、可开源发布的 reveal.js 分享模板库。它把页面布局、导航、样式和导出流程收进一个包里，让使用者主要只需要维护 content/slides.js。

作为脚手架使用

npx reveal-team-share init my-deck
cd my-deck
npm install
npm run dev

生成后的项目里，通常只需要改：

content/slides.js

作为库使用

在你自己的 Vite 项目里安装：

npm install reveal-team-share

然后在入口文件里：

import { createRevealShareApp } from "reveal-team-share";
import { deck } from "../content/slides.js";

createRevealShareApp({ deck });

项目结构

• src/createRevealShareApp.js：核心渲染与 reveal.js 初始化
• bin/reveal-team-share.js：CLI，负责 init 和 export-pdf
• template/default/：新项目模板
• scripts/export-pdf.mjs：通用 PDF 导出脚本

开发这个仓库

npm install
npm run dev

根目录仍然保留一个本地示例工程，方便你继续迭代视觉和交互。

导出 PDF

在生成后的项目里执行：

npm run build
npm run export:pdf

要求本机安装 Chrome 或 Chromium。

发布前建议

• 先确认 npm 包名 reveal-team-share 仍然可用
• 在 GitHub 仓库开启 Issues / Discussions，方便收集模板需求

CI 与发版

• CI 工作流会在 push 和 pull request 时自动跑 npm ci、npm run build 和 npm pack --dry-run
• Publish to npm 工作流会在 GitHub Release 发布后自动执行 npm publish --provenance --access public
• 工作流文件在 .github/workflows/ci.yml 和 .github/workflows/publish-npm.yml

首次发布 checklist

1. 在 npm 上确认包名可用
2. 在 npm 包设置里配置 GitHub Trusted Publisher，关联这个仓库
3. 确认 package.json 版本号正确
4. 在 GitHub 上创建一个对应版本的 Release
5. 等待 Publish to npm 工作流完成

内容编写说明

完整内容字段说明见 USAGE.md。