Slidev Example

Play with Slidev

The best way of understanding Slidev is to try it, with the following command:

# Skip this step if you're already familiar with `Slidev`
yarn init slidev@latest

Build Single Page Applications (SPA) for GitHub Pages

Init this project

yarn install
# Or install slidev globally
# Then use it everywhere without creating a new project
yarn i -g @slidev/cli

Update your slides

You can update your slides content by editing the slides.md file.

For multiple slide entries, you can check here.

Build the slides into a self-hostable SPA

# Build the slides into static files
# Or use slidev directly if it's globally installed
# slidev build --base /slidev/
yarn run build
# The generated application will be available under `dist/`.
# Copy everything under `dist/` to `docs/` to make Github Pages work
# Make sure .nojekyll file should always exist under `docs/`
# https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/
cp -r dist/* docs/

Further reading

Learn more at Slidev.