Upgrade Notes

This theme is preparing for a major upgrade. Upcoming releases may include breaking changes that affect existing decks.

What might be affected

Depending on your setup, upgrading may require changes in one or more areas:

Slidev / Node.js requirements: ensure your local environment matches the versions required by the theme.
Theme configuration: some frontmatter keys and themeConfig options may change.
Layouts / components: layout names, props, defaults, or styling tokens may change.
Build/export behavior: PDF export and asset handling may be affected by upstream Slidev changes.

Check your Node.js version (the theme requires Node.js 20+):
bash
```
node -v
```
Upgrade Slidev to a compatible version:
bash
```
npm i -D @slidev/cli
```
Upgrade the theme:
bash
```
npm i -D slidev-theme-scholarly
```
Start Slidev and fix any reported errors:
bash
```
npx slidev
```

If something breaks, pin the previous version temporarily while you migrate.

We publish pre-releases for testing changes before a stable release.

Type	Tag format	Example
Stable	`vX.Y.Z`	`v2.0.0`
Pre-release	`vX.Y.Z-<pre>`	`v2.0.0-beta.1`, `v2.0.0-rc.0`

Pre-releases follow SemVer and must include the -<pre> prerelease segment; otherwise, the CI will treat them as stable releases.

Install the current pre-release channel:
bash
```
npm i -D slidev-theme-scholarly@next
```
Return to the stable channel:
bash
```
npm i -D slidev-theme-scholarly
```