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 репозитория. В монорепозитории также есть готовые примеры для запуска (JS, TypeScript, MD, MDX и настройка на одной странице).
Нужно ли знать React, чтобы сделать презентацию?Да — слайды это React-компоненты, написанные на JSX, так что знание React и есть главное требование. Сам репозиторий — это монорепозиторий на pnpm, требующий Node.js >= 22.
Проект живой или стоит ждать, что он брошен?Проект живой: в README он помечен как Active, и Formidable планирует работать над ним и дальше. Настоящая загвоздка в том, что слайды — это код: графического редактора нет.
Где мне в итоге показывать готовую презентацию?В веб-браузере — презентации представляют собой React-приложения, так что носить с собой файл PowerPoint или Keynote не нужно. Про экспорт в PDF или PPTX в README не упоминается.
Есть ли инструмент-скаффолдер, чтобы быстро начать презентацию?Да — в CI репозитория есть workflow create-spectacle, что согласуется с упоминанием в README сопутствующих инструментов рядом с основным пакетом; точные команды смотрите на сайте документации.
Можно ли писать слайды на Markdown вместо JSX?Да — в монорепозитории есть отдельные примеры для 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