@jbonigomes/create-react-slides
Version:
React presentation deck framework heavily inspired by Impress.js
46 lines (31 loc) • 1.6 kB
Markdown
# Create React Slides
This is a React app, heavily inspired by the known and loved
[Impress.js](https://impress.js.org).
It is a lot less feature rich but let's you create slides as separate React
components leaving the slides author free to be creative.
## Getting started
npx @jbonigomes/create-react-slides my-awesome-presentation
cd my-awesome-presentation
npm start
## Creating slides
Create a React component under `src/slides` (Samples provided) then add it to
the routes array on `src/routes.js`, note that the order in which components
appear in the array will be the order in which they render in the presentation.
Each slide must have at least one `Step` and be wrapped by a `Slide`. Refer to
samples.
## Slides navigation
Google Chrome is the only supported browser, navigation can be achieved by the
space bar `␣`, left `←` and right `→` arrows. You may also add multiple steps
per slide and switch them with the up `↑` and down `↓` arrows.
## Images
Images should be added to the `src/img` folder. They can then be consumed via
the `Img` component. Samples provided in the slides.
## Fonts
You can add fonts via WebFontLoader (Google fonts and the likes), in the
`index.js` file.
## Code highligthing
Code highligthing is done via [Prism.js](https://prismjs.com), wrapped via the
`Highlight` component. By default it will only highlight Markup, CSS, JS and
C-Like languages. You can however load other languages on
`src/components/Highlight/index.js`. Samples on usage are included in the
sample slides. By default the `Okaidia` theme is in preset.