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

第18章 Slidev 第18章:自定义配置详解

自定义配置

Slidev 支持全面自定义,从样式到工具配置都可以调整,还能配置底层的各种工具(Vite、UnoCSS、Monaco 等)。

幻灯片项目配置

你可以在第一张幻灯片的 frontmatter(即 headmatter)中配置整个幻灯片项目。以下是各选项的默认值:

yaml --- # 主题 ID、包名或本地路径 # 了解更多:https://sli.dev/guide/theme-addon.html#use-theme theme: default # 插件,可以是包名列表或本地路径 # 了解更多:https://sli.dev/guide/theme-addon.html#use-addon addons: [] # 幻灯片标题,未指定时会从第一个标题推断 title: Slidev # 网页标题模板,`%s` 会被替换为幻灯片的标题 titleTemplate: '%s - Slidev' # 幻灯片的信息,可以是 Markdown 字符串 info: false # 导出 PDF 或 PPTX 时使用的作者字段 author: Your Name Here # 导出 PDF 时使用的关键词字段,逗号分隔 keywords: keyword1,keyword2

# 启用演讲者模式,可选 boolean、'dev' 或 'build' presenter: true # 启用浏览器导出功能,可选 boolean、'dev' 或 'build' browserExporter: dev # 在 SPA 构建中启用 PDF 下载,也可以指定自定义 URL download: false # 导出文件的文件名 exportFilename: slidev-exported # 导出选项 # 使用导出 CLI 选项的 camelCase 格式 # 了解更多:https://sli.dev/guide/exporting.html export: format: pdf timeout: 30000 dark: false withClicks: false withToc: false # 启用 twoslash,可选 boolean、'dev' 或 'build' twoslash: true # 在代码块中显示行号 lineNumbers: false # 启用 Monaco 编辑器,可选 boolean、'dev' 或 'build' monaco: true # Monaco 类型加载来源,可选 'cdn'、'local' 或 'none' monacoTypesSource: local # 显式指定额外的本地包以导入其类型 monacoTypesAdditionalPackages: [] # 显式指定额外的本地模块作为 Monaco 可运行代码的依赖 monacoRunAdditionalDeps: [] # 使用 vite-plugin-remote-assets 在本地下载远程资源,可选 boolean、'dev' 或 'build' remoteAssets: false # 控制幻灯片中的文字是否可选 selectable: true # 启用幻灯片录制,可选 boolean、'dev' 或 'build' record: dev # 启用 Slidev 的右键菜单,可选 boolean、'dev' 或 'build' contextMenu: true # 启用屏幕常亮,可选 boolean、'dev' 或 'build' wakeLock: true # 启用 PWA 支持以预缓存资源供离线使用,可选 boolean、'dev' 或 'build' # 了解更多:https://sli.dev/features/pwa.html pwa: false # 在总览页面为每张幻灯片截取快照 overviewSnapshots: false # vue-router 的路由模式,可选 "history"、"hash" 或 "memory" routerMode: history

# 强制幻灯片的配色模式,可选 'auto'、'light' 或 'dark' colorSchema: auto # 幻灯片的宽高比 aspectRatio: 16/9 # 画布的实际宽度,单位为 px canvasWidth: 980 # 定义幻灯片之间的默认过渡效果 # 了解更多:https://sli.dev/guide/animations.html#slide-transitions transition: undefined # 或 BuiltinSlideTransition | string | TransitionGroupProps | null # 定义点击动画的默认动画预设 # 了解更多:https://sli.dev/guide/animations.html#click-animation-presets clickAnimation: undefined # 或逗号分隔的字符串 # 用于主题自定义,属性 `x` 会以 `--slidev-theme-x` 的形式注入根样式 themeConfig: primary: '#5d8392'

# 网站图标,可以是本地文件路径或 URL favicon: 'https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png' # 用于渲染图表的 PlantUML 服务器 URL # 了解更多:https://sli.dev/features/plantuml.html plantUmlServer: https://www.plantuml.com/plantuml # 字体会从 Google Fonts 自动导入 # 了解更多:https://sli.dev/custom/config-fonts.html fonts: sans: Roboto serif: Roboto Slab mono: Fira Code

# 适用于所有幻灯片的默认 frontmatter defaults: layout: default # ...

# 绘图选项 # 了解更多:https://sli.dev/guide/drawing.html drawings: enabled: true persist: false presenterOnly: false syncAll: true

# HTML 标签属性 htmlAttrs: dir: ltr lang: en

# SEO meta 标签 seoMeta: ogTitle: Slidev Starter Template ogDescription: Presentation slides for developers ogImage: https://cover.sli.dev ogUrl: https://example.com twitterCard: summary_large_image twitterTitle: Slidev Starter Template twitterDescription: Presentation slides for developers twitterImage: https://cover.sli.dev twitterSite: username twitterUrl: https://example.com ---

更多细节请查看类型定义。

单页幻灯片配置

每张幻灯片也可以在自己的 frontmatter 块中配置以下选项。以下是各选项的默认值:

yaml --- # 自定义点击次数 # 了解更多:https://sli.dev/guide/animations#total clicks: 0 # 自定义起始点击次数 clicksStart: 0 # 背景图片 URL、本地资源路径或颜色/渐变 background: undefined # 或字符串(如 'https://cover.sli.dev' 或 '/image.png') # 完全禁用并隐藏该幻灯片 disabled: false # 与 `disabled` 相同 hide: false # 在 组件中隐藏该幻灯片 hideInToc: false # 该幻灯片应用的布局组件 layout: <如果该幻灯片是第一张则为 "cover",否则为 "default"> # 添加到幻灯片根元素上的自定义 class class: undefined # 或 string | string[] | Record # 为 和 组件覆盖标题级别 # 仅在同时声明了 `title` 时生效 level: 1 # 进入前预加载该幻灯片 preload: true # 创建一个可在 URL 或 组件中使用的路由别名 routeAlias: undefined # 或 string # 引入一个 Markdown 文件 # 了解更多:https://sli.dev/guide/syntax.html#importing-slides src: undefined # 或 string # 为 和 组件覆盖标题 # 仅在同时声明了 `title` 时生效 title: undefined # 或 string # 定义该幻灯片与下一张之间的过渡效果 # 了解更多:https://sli.dev/guide/animations.html#slide-transitions transition: undefined # 或 BuiltinSlideTransition | string | TransitionGroupProps | null # 定义该幻灯片内点击动画的默认动画预设 # 了解更多:https://sli.dev/guide/animations.html#click-animation-presets clickAnimation: undefined # 或逗号分隔的字符串 # 自定义缩放比例 # 对内容较多的幻灯片很有用 zoom: 1 # 用作可拖拽元素的位置 # 了解更多:https://sli.dev/features/draggable.html dragPos: {} # 类型:Record ---

更多细节请查看类型定义。

目录结构

Slidev 通过目录结构约定来减少配置量,并让功能扩展更加灵活直观。

参见"目录结构"章节。

工具配置

配置语法高亮器 配置 Vite 及插件 配置 Vue 应用 配置 UnoCSS 配置代码运行器 配置 Transformers 配置 Monaco 配置 KaTeX 配置 Mermaid 配置 Mermaid 渲染器 配置路由 配置快捷键 配置右键菜单 配置字体 配置预解析器

评论 (0)