Skip to content

zlict/slidev-theme

Repository files navigation

@zlict/slidev-theme-zli

NPM version

Our companys theme for Slidev.

Use

Add the following frontmatter to your slides.md. Start Slidev then it will prompt you to install the theme automatically.

---
theme: @zlict/slidev-theme-zli
---

Learn more about how to use a theme.

Layouts

This theme provides the following layouts:

TODO:

Components

This theme provides the following components:

TODO:

Contribute

  1. Make sure you have Docker up and running
  2. Get Visual Studio Code with Dev Containers ready
  3. Open the project inside a Dev Container and run pnpm install
    • If needed for export or screenshots, install playwright dependencies with sudo npx playwright install-deps
  4. pnpm run dev to start theme preview of example.md
  5. Edit the example.md and style to see the changes
  6. pnpm run export to generate the preview PDF
  7. pnpm run screenshot to generate the preview PNG
  8. Commit and push your changes or create a pull request
  9. Release a new version with pnpm run release:patch, pnpm run release:minor or pnpm run release:major