@henriburau/slides (0.1.0)
Installation
@henriburau:registry=https://gitea.henriburau.de/api/packages/ace966/npm/npm install @henriburau/slides@0.1.0"@henriburau/slides": "0.1.0"About this package
@henriburau/slides
Slidev addon with shared layouts, components and styles, plus a check for overflowing slides.
Usage
The package is published to the Gitea npm registry. Point the @henriburau
scope at it in the project's .npmrc:
@henriburau:registry=https://gitea.henriburau.de/api/packages/ace966/npm/
Install it together with Playwright, which the overflow check needs:
pnpm add @henriburau/slides
pnpm add -D playwright-chromium
Enable the addon in the headmatter of slides.md:
addons:
- '@henriburau/slides'
Overflow check
check-overflow renders every slide with all clicks revealed and lists the
slides whose content does not fit. It uses the project's own @slidev/cli
and playwright-chromium.
"scripts": {
"check-overflow": "check-overflow"
}
pnpm check-overflow [entry.md] [--scroll]
--scroll also lists boxes that scroll vertically, such as code blocks with
maxHeight. The command exits with code 1 if any slide overflows.
Testing
pnpm test
Builds example.md with the addon, which fails if a component or layout does
not compile. Only components used in a slide are compiled, so add every new
component to example.md. Preview the deck with pnpm exec slidev example.md.
Releasing
pnpm release
The script checks that main is clean and up to date, runs pnpm test,
bumps the version, commits and tags vX.Y.Z and offers to push. The Gitea
workflow publishes every pushed v* tag. Versions with a suffix such as
1.2.0-rc.1 are published under the next dist-tag.
Dependencies
Dependencies
| ID | Version |
|---|---|
| @iconify-json/mdi | ^1.2.3 |
| @slidev/client | ^52.11.3 |
| @vueuse/core | ^14.1.0 |
| @vueuse/integrations | ^14.1.0 |
| qrcode | ^1.5.4 |
Development Dependencies
| ID | Version |
|---|---|
| @slidev/cli | ^52.20.1 |
| husky | ^9.1.7 |
| vue | ^3.5.43 |
Peer Dependencies
| ID | Version |
|---|---|
| vue | ^3.5.43 |