Install dependencies:
npm install
Run the development server:
npm start
Build the slideshow:
npm run build
The slides make use of values in a .env
file during development. You can put one at the root of the repo with values used in import.meta.env
properties.
# example .env file
VITE_GOOGLE_MAPS=your-maps-key-here
The slides.md
file contains markdown for the slides. See the Slidev docs for details on the syntax.
Examples are embedded in iframes using the special iframe-unscaled
layout. When working on an example, you can load the example page directly instead of viewing it in the slideshow (e.g. http://localhost:3030/examples/basic-map.html).
See the Slidev Icons doc for instructions in including icons in markdown.
Look through the Twemoji collection to find icon names.
-
After adding a new example, you need to restart the dev server so it gets picked up (otherwise you'll see a 404).
-
After viewing one of the map examples, if you can't navigate with the keyboard, hover over the bottom left of the page to get the previous/next slide controls.
-
Periodically, the screen may go blank during development. If you see
Uncaught TypeError: Cannot read properties of undefined (reading 'currentRoute')
in the console, you may need to close the tab, stop the dev server, and start over. Keep an eye on slidevjs/slidev#1925 to see if this is addressed in Slidev. -
I've found I need to clear the browser cache periodically. If things go really bad, you can delete the
node_modules/.vite
folder and start the dev server again. -
Although Vite accepts a JavaScript
vite.config.js
file, Slidev requiresvite.config.ts
.