Skip to content

About

Hoverkraft theme for Slidev

Topics

Resources

Code of conduct

Contributing

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

@hoverkraft/slidev-theme

Logo for Continuous Integration - GitHub - Publish

GitHub Verified Creator Continuous Integration GitHub tag License PRs Welcome

Overview

Hoverkraft-branded theme for Slidev, organized with the same package, slides, DevX, and CI/CD patterns used by the Hoverkraft Docusaurus theme repository.

@hoverkraft/slidev-theme delivers a production-ready Hoverkraft presentation baseline for Slidev decks. The theme ships fixed brand colors, typography, code highlighting defaults, and a branded cover layout so teams can focus on deck content instead of rebuilding presentation chrome.

Feature Highlights

  • Enforced branding: Colors and typography follow the Hoverkraft visual system.
  • Slidev-native structure: Published theme assets live in packages/theme using Slidev's layouts and styles conventions.
  • Default addons: Typst, pager, progress, zoom, pane, and Rabbit support are enabled through theme defaults.
  • Example deck: packages/slides provides a local Slidev deck for QA and documentation.
  • Package verification: CI builds, packs, installs, and rebuilds the example deck from the produced tarball.

Packages

Package Description
packages/theme Published @hoverkraft/slidev-theme package with layouts and styles.
packages/slides Private Slidev example deck used for local preview and package smoke tests.

Installation

npm install -D @hoverkraft/slidev-theme

The theme ships its default addon stack as package dependencies, so installing the theme pulls in the supported addon set automatically:

npm install -D @hoverkraft/slidev-theme

Configure your Slidev deck frontmatter:

---
theme: "@hoverkraft/slidev-theme"
---

Use the branded cover layout:

---
layout: cover
---

# My presentation

Built with Hoverkraft Slidev theme.

Development

Requires Node.js >=20.12.0 for the local Slidev slides workspace.

Use the root workspace commands for daily work:

make setup      # Install workspace dependencies
make lint       # Run lint checks
make test       # Run unit tests
make build      # Validate package and slides build
make start      # Start the example Slidev deck

Equivalent npm commands are available for CI and editor integrations:

npm install
npm run lint
npm run test
npm run build
npm run start

Testing

Theme unit tests live in packages/theme/test. The slides package is intentionally treated as a smoke-test deck: CI installs the packaged theme tarball into packages/slides and runs the Slidev build.

Default Addons

The theme enables these addons through slidev.defaults.addons:

Declaring addons in a deck replaces the theme default list, so decks that customize addons should include any Hoverkraft defaults they still need.

Maintainer documentation

See the documentation index for release setup and operation.

License

MIT License - see LICENSE for details.

About

Hoverkraft theme for Slidev

Topics

Resources

Code of conduct

Contributing

Accessibility

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages