spectacle README

The project's README from github.com/FormidableLabs/spectacle. As one markdown file: README.md.

Spectacle

✨ A ReactJS based Presentation Library ✨

Maintenance Status

Getting Started

Welcome to our monorepo project, housing the core spectacle package and related tools and examples.

Come learn more at our docs site!

Support

Have a question about Spectacle? Submit an issue in this repository using the "Question" template.

Notice something inaccurate or confusing? Feel free to open an issue or make a pull request to help improve the documentation for everyone!

The source for our docs site lives in this repo in the docs folder.

Contributing

Please see our contributing guide.

Maintenance Status

Active: Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.

spectacle (FormidableLabs/spectacle)

Searching Database…

10.2K ·GitHub
这是什么?Spectacle 是一个基于 React 的演示文稿库:你可以用 JSX 组件编写精美的幻灯片,还能在演讲时现场演示代码。
它是一款像 Keynote 那样的应用,还是我要用代码来做幻灯片?它是一个库,不是独立应用。幻灯片是你用代码编写的 React 组件,做好的演示文稿以网页形式运行,而不是 .pptx 文件。
如果我想试试,该从哪里入手?按照 README 中链接的文档站点操作——它的源码在仓库的 docs 文件夹里。这个 monorepo 还附带可以直接运行的示例(JS、TypeScript、MD、MDX 以及一个单页上手指南)。
做演示文稿需要会 React 吗?需要——幻灯片是用 JSX 编写的 React 组件,所以熟悉 React 才是真正的门槛。仓库本身是一个 pnpm monorepo,要求 Node.js >= 22。
它还在维护吗?还是说我要做好项目已弃坑的打算?它还在活跃维护:README 把它标记为 Active,Formidable 在可预见的将来会持续投入。真正的限制在于幻灯片就是代码——没有图形化编辑器。
演示文稿做好之后,我在哪里放映?在网页浏览器里——演示文稿就是 React 应用,所以不需要携带任何 PowerPoint 或 Keynote 文件。README 没有提到导出 PDF 或 PPTX 的功能。
有没有脚手架工具可以快速创建一个演示文稿?有——仓库的 CI 里包含一个 create-spectacle 工作流,与 README 中提到的核心包之外的相关工具相吻合;具体命令请查看文档站点。
我可以用 Markdown 而不是 JSX 来写幻灯片吗?可以——monorepo 里有专门的 Markdown 和 MDX 示例,并带有各自的启动脚本(pnpm start:md、start:mdx),所以演示内容可以放在 .md/.mdx 文件里。
幻灯片里的实时写代码是怎么实现的?现场演示代码是 Spectacle 的招牌功能:幻灯片可以展示你在演讲时真正运行的代码,而不是贴上去的截图。细节请看文档站点。
What are similar projects?mdx-deck, nodeppt, pdfcn, bolt-slides, marp, open-slide, hooks, nuqs
Size
144.1 MB
Stars
10.2K
Age
11y
Commits · 90 Days