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

第15章 Slidev 命令行工具(CLI)详解

Slidev CLI @slidev/cli 暴露了一个名为 slidev 的二进制文件,你可以用它来开发、构建和导出幻灯片。

前置条件 要使用 CLI,你可以将 @slidev/cli 全局安装,或在 Node.js 项目中本地安装。如果通过 npm init slidev 创建项目,CLI 已本地安装。

警告 npx slidev 通常不受支持,因为包名实际为 @slidev/cli。

命令的 CLI 选项遵循以下约定:选项值可在空格或 = 字符后传入,例如:slidev --port 8080 等价于 slidev --port=8080。对于布尔选项,可以省略 true,例如:slidev --open 等价于 slidev --open true。

信息 如果使用 npm,请记住在选项前添加 -- 以便将选项传递给 Slidev: bash npm run slidev -- --remote --port 8080 --open

slidev [entry] 为 Slidev 启动本地服务器。

[entry](string,默认:slides.md):包含幻灯片的 Markdown 文件路径。

选项: --port, -p(number,默认:3030):端口号。 --base(string,默认:/):基础 URL(参见 https://vitejs.dev/config/shared-options.html#base)。 --open, -o(boolean,默认:false):在浏览器中打开。 --remote [password](string):监听公共主机并启用远程控制。如果传入值,则演示者模式为私有,仅可通过在 URL 查询的 password 参数中提供指定密码来访问。 --bind(string,默认:0.0.0.0):指定远程模式下服务器监听的 IP 地址。 --log('error'、'warn'、'info'、'silent',默认:'warn'):日志级别。 --force, -f(boolean,默认:false):强制优化器忽略缓存并重新打包。 --theme, -t(string):覆盖主题。

slidev build [entry] 构建可托管的 SPA。详情参见 📖 托管。

[entry](string,默认:slides.md):幻灯片 Markdown 文件路径。

选项: --out, -o(string,默认:dist):输出目录 --base(string,默认:/):基础 URL(参见 https://vitejs.dev/config/shared-options.html#base) --download(boolean,默认:false):允许在 SPA 内将幻灯片下载为 PDF --theme, -t(string):覆盖主题 --without-notes(boolean,默认:false):从 SPA 中排除演讲者备注

slidev export [...entry] 导出幻灯片为 PDF(或其他格式)。详情参见 📖 导出。

[entry](string,默认:slides.md):幻灯片 Markdown 入口路径。

选项: --output(string,默认:使用 exportFilename(参见 https://sli.dev/custom/#headmatter)或 [entry]-export):输出路径。 --format('pdf'、'png'、'pptx'、'pptx-editable'、'md',默认:'pdf'):输出格式。pptx 将每张幻灯片导出为图像;pptx-editable 将其重构为原生 PowerPoint 形状,文本可选中。 --timeout(number,默认:30000):渲染打印页面的超时时间(参见 https://playwright.dev/docs/api/class-page#page-goto)。 --range(string):导出的页码范围(示例:'1,4-5,6')。 --dark(boolean,默认:false):以深色主题导出。 --with-clicks, -c(boolean,PPTX 格式默认为 true,其他为 false):为每个点击动画导出页面(参见 https://sli.dev/guide/animations.html#click-animation)。 --theme, -t(string):覆盖主题。 --omit-background(boolean,默认:false):移除默认浏览器背景

slidev export-notes [...entry] 将演讲者备注导出为 PDF。仅包含带有备注的幻灯片,包括其标题和幻灯片编号,但不含幻灯片预览。示例和前置条件参见导出演讲者备注。

[entry](string,默认:slides.md):幻灯片 Markdown 入口路径。

选项: --output(string,默认:如果配置了 exportFilename 则为 [exportFilename]-notes.pdf,否则为 [entry]-export-notes.pdf):输出路径。如果省略,将自动添加 .pdf 扩展名。 --timeout(number,默认:30000):渲染打印页面的超时时间(毫秒)。 --wait(number,默认:0):导出前的额外延迟(毫秒)。

slidev format [entry] 格式化 Markdown 文件。注意:这不会格式化幻灯片内容,仅整理 Markdown 文件结构。

[entry](string,默认:slides.md):幻灯片 Markdown 入口路径。

slidev mcp [entry] 启动一个基于 stdio 的 MCP(Model Context Protocol)服务器,供 AI 代理检查和编辑幻灯片。详情参见 ✨ MCP 服务器。

[entry](string,默认:slides.md):幻灯片 Markdown 入口路径。

slidev theme [subcommand] 主题相关操作。

子命令: eject [entry]:将当前主题弹出到本地文件系统。详情参见 ✨ 弹出主题。[entry](string,默认:slides.md):幻灯片 Markdown 入口路径。 选项: --dir(string,默认:theme):输出目录。 --theme, -t(string):覆盖主题。

评论 (0)