进阶 sli.dev 2026-11-21 18:58:32 · 1 阅读

第13章 编写 Slidev 主题

编写主题

​请务必先阅读 📖 主题与插件 指南。

每个 Slides 项目只能使用一个主题。主题应专注于提供幻灯片的视觉外观。如果某项功能与外观无关且可独立使用,建议将其实现为插件(Addon)。

要开始创建主题,我们推荐使用生成器来搭建初始项目结构:

`pnpm create slidev-theme` `npm init slidev-theme@latest` `yarn create slidev-theme` `bun create slidev-theme` `deno init --npm slidev-theme`

之后,你可以自由修改和调试代码。也可以参考官方主题作为示例。

功能 ​

主题可以实现以下功能: - 提供全局样式 - 提供默认配置 - 提供自定义布局或覆盖现有布局 - 提供自定义组件 - 配置 UnoCSS、Shiki 等工具

然而,不建议在主题中实现以下功能,这些功能更适合以插件形式实现: - 新的代码片段 - 新的代码运行器 - 其他可独立使用的功能

基本上,提供全局样式、布局、组件以及配置工具的方式与在 Slides 项目中操作相同。例如,要配置 Shiki,可以按照“配置代码高亮器”指南中所述创建 `./setup/shiki.ts`。更多细节请参阅定制化指南。

要提供默认的 Slidev 配置,可以在 `package.json` 文件中添加 `slidev.defaults` 字段,该字段将与用户配置合并:

`{ "slidev": { "defaults": { "transition": "slide-left", "aspectRatio": "4/3" } } }`

要求 Slidev 版本

如果主题依赖于 Slidev 新引入的特定功能,可以设置运行该主题所需的最小 Slidev 版本:

`{ "engines": { "slidev": ">=0.48.0" } }`

如果使用不兼容的版本,将显示错误消息。

主题元数据

默认情况下,Slidev 假设主题同时支持浅色模式和深色模式。如果只希望主题在特定色彩模式下呈现,需要在 `package.json` 中明确指定:

`{ "slidev": { "colorSchema": "light" // 或 "dark" 或 "both" } }`

预览

开发主题时,可以使用演示幻灯片进行预览。创建包含以下 frontmatter 的 `./slides.md` 文件:

`--- theme: ./ # 使用当前目录下的主题 ---`

然后像往常一样启动演示幻灯片即可。

发布

发布主题时,`.vue` 和 `.ts` 等非 JS 文件可以直接发布而无需编译。Slidev 在使用主题时会自动编译它们。

主题应遵循以下规范: - 包名应以 `slidev-theme-` 开头。例如 `slidev-theme-name` 或 `@scope/slidev-theme-name` - 在 `package.json` 的 `keywords` 字段中包含 "slidev-theme" 和 "slidev"

主题可以在不发布到 NPM 的情况下在本地使用。如果主题仅供个人使用,可以将其作为本地主题使用,或发布为私有 scope 包。但如果希望与他人分享,建议发布到 NPM 注册表。

评论 (0)