title: 安装

安装 {#installation}

初始模板 {#starter-template}

Slidev 需要 Node.js 的版本 >=14.0.0

快速开始最好的方式就是使用官方的初始模板。

使用 NPM：

$ npm init slidev@latest

使用 Yarn：

$ yarn create slidev

跟随命令行的提示，它将自动为你打开幻灯片，网址是 http://localhost:3030/。

同时包含了一些基本配置和简单的 demo，为你说明如何开始使用 Slidev。

手动安装 {#install-manually}

如果你倾向于手动安装 Slidev，或者想把它集成到你已有的项目中，你可以执行如下操作：

$ npm install @slidev/cli @slidev/theme-default

$ touch slides.md

$ npx slidev

请注意，如果你使用的是 pnpm，请先启用 shamefully-hoist 选项，才能使得 Slidev 正常工作。
echo 'shamefully-hoist=true' >> .npmrc

全局安装 {#install-globally}

自 v0.14 开始可用

你可以使用如下命令在全局安装 Slidev：

$ npm i -g @slidev/cli

然后即可在任何地方使用 slidev，而无需每次都创建一个项目。

$ slidev

如果在本地的 node_modules 目录下找到了 @slidev/cli，此命令也同样有效。

在 Docker 上安装 {#install-on-docker}

如果你需要快速的在容器上部署你的演示文稿，你可以使用由 tangramor 维护的预构建 docker 镜像，或者自行构建。

在你的工作目录下运行下面的命令：

docker run --name slidev --rm -it \
    --user node \
    -v ${PWD}:/slidev \
    -p 3030:3030 \
    tangramor/slidev:latest

如果你的工作目录为空，容器会在目录下自动创建 slides.md 文件和其它相关文件，并基于 3030 端口启动 slidev 服务。

你可以通过 http://localhost:3030/ 访问你的幻灯片。

构建可部署镜像 {#build-deployable-image}

你也可以把你的 slidev 幻灯片构建到一个 docker 镜像里来进行部署，Dockerfile 如下：

FROM tangramor/slidev:latest
ADD . /slidev

使用命令 docker build -t myppt . 来构建镜像。

执行 docker run --name myslides --rm --user node -p 3030:3030 myppt 命令来运行镜像。

这时你就可用通过 http://localhost:3030/ 来打开你的幻灯片了。

构建单网页应用 {#build-hostable-spa-single-page-application}

在前面启动的 slidev 容器上运行命令 docker exec -i slidev npx slidev build 就可以在 dist 目录下将你的幻灯片生成静态 HTML 文件。

使用 Github Pages 托管 {#host-on-github-pages}

你可以在静态 Web 站点上托管生成的静态文件，比如 Github pages 或 Gitlab pages。

由于 Github pages 的 URL 可能包含二级目录，所以你需要修改生成的 index.html，把 href="/assets/xxx 改为 href="./assets/xxx （即使用相对路径）。或者你可以用 vite 的 --base=/<subfolder>/ 选项来指定二级目录，例如： docker exec -i slidev npx slidev build --base=/slidev_docker/。

为了防止触发 Jekyll 构建流程，你需要在静态站根目录下添加一个名为 .nojekyll 的空文件

使用 docker 托管 {#host-by-docker}

你当然也可以使用 docker 容器来托管生成的静态文件：

docker run --name myslides --rm -p 80:80 -v ${PWD}/dist:/usr/share/nginx/html nginx:alpine

或者使用下面的 Dockerfile 来构建一个静态站点的容器镜像：

FROM nginx:alpine
COPY dist /usr/share/nginx/html

运行 docker build -t mystaticppt . 来构建镜像

执行 docker run --name myslides --rm -p 80:80 mystaticppt 命令来启动容器。

此时你就可以通过 http://localhost/ 来访问你的幻灯片了。

关于容器的更多详细信息，请参考 tangramor/slidev_docker 仓库。

Command Line Interface (CLI) {#command-line-interface-cli}

@slidev/cli 暴露了一些命令，你可以通过 npx slidev ... 或者在你的 package.json 中添加 script 来使用它们。

{
  "script": {
    "dev": "slidev"
  }
}

在这种情况下，你可以通过 npm run dev 来运行。

你可以向任何命令传参：

boolean 选项如果存在则为 true，否则为 false（例如：slidev --open）
一些选项可以在选项后添加数值，或者使用 = 字符（例如：slidev --port 8080 或者 slidev --port=8080）

如果你使用 npm 的 script，别忘了在 npm 命令后加上 --：

npm run slidev -- --open

`slidev [entry]` {#slidev-entry}

为 Slidev 启动一个本地服务器。

[entry]（string，默认值：slides.md）：幻灯片 markdown 的入口文件。

选项：

--port，-p（number，默认值：3030）：端口号。
--open，-o (boolean，默认值：false)：在浏览器打开。
--remote [password] (string)：监听公共主机并启用远程控制，如果传递了该值，那么演讲者模式是私有的，只有通过在 URL 查询 password 参数中给定的密码才能访问。
--log ('error'，'warn'，'info'，'silent'，默认值：'warn')：日志级别。
--force，-f (boolean，默认值：false)：强制优化器忽略缓存，并重新构建。
--theme，-t (string)：覆盖主题。

`slidev build [entry]` {#slidev-build-entry}

建立可托管的 SPA。

[entry]（string，默认值：slides.md）：幻灯片 markdown 的入口文件。

选项：

--watch，-w (boolean，默认值：false)：构建观察。
--out，-o (string，默认值：dist)：要输出到的目标文件夹。
--base (string，默认值：/)：base URL（参阅 https://cli.vuejs.org/config/#publicpath）
--download (boolean，默认值：false)：允许在 SPA 内下载 PDF 格式的幻灯片。
--theme，-t (string)：覆盖主题。

`slidev export [entry]` {#slidev-export-entry}

将幻灯片导出为 PDF（或者其他格式）。

[entry] (string，默认值：slides.md)：幻灯片 markdown 的入口文件。

Options:

--output (string，默认值：use exportFilename (参阅 https://sli.dev/custom/#frontmatter-configures) 或使用 [entry]-export)：输出的路径。
--base ('pdf'，'png'，'md'，默认值：'pdf')：输出的格式。
--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，默认值：false)：输出每次点击的页面（参阅 https://sli.dev/guide/animations.html#click-animations)。
--theme，-t (string)：覆盖主题。

`slidev format [entry]` {#slidev-format-entry}

格式化 markdown 文件。

[entry] (string，默认值：slides.md)：幻灯片 markdown 的入口文件。

`slidev theme [subcommand]` {#slidev-theme-subcommand}

与主题相关的业务。

子命令：

eject [entry]：将当前主题弹出到本地文件系统中
- [entry] (string，默认值：slides.md)：幻灯片 markdown 的入口文件。
- 选项：
  - --dir (string，默认值：theme)：要输出到的目标文件夹。
  - --theme，-t (string)：覆盖主题。

安装