FormidableLabs / spectacle

A React-based library for creating sleek presentations using JSX syntax that gives you the ability to live demo your code.
https://commerce.nearform.com/open-source/spectacle/
MIT License
9.7k stars 690 forks source link

Revamped `create-spectacle` CLI and getting started documentation for Spectacle. #1306

Closed carloskelly13 closed 6 months ago

carloskelly13 commented 7 months ago
  1. Updated create-spectacle CLI to have new Markdown option, make One Page first class, and remove older JS-based options.
Screenshot 2023-12-15 at 9 10 55 AM
  1. Revamped Spectacle documentation to remove old installation methods and show a cleaner getting started guide using the new CLI → https://spectacle-docs-website-git-feature-creat-c38d7e-formidable-labs.vercel.app/docs/

How to test

  1. cd into packages/create-spectacle and run pnpm dev
  2. run through each option
  3. cd into the generated directories and run npm i && npm start to verify each output type works
  4. for one-page just double click the html file and see that it loads

For release this will get folded into this changeset for the CLI → https://github.com/FormidableLabs/spectacle/pull/1305

vercel[bot] commented 7 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
spectacle-docs-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 15, 2023 4:01pm