第9章 构建与托管
第9章 Hosting
构建与托管
Slidev 在编辑或演示幻灯片时是以 web 服务器形式运行的。但演示结束后,你可能还想把交互式幻灯片分享给他人。本指南将介绍如何构建和托管你的幻灯片。
构建为 SPA
通过以下命令可以把幻灯片构建成静态的单页应用(SPA):
bash $ slidev build
默认情况下,生成的文件会放在 dist 文件夹中。你可以运行 npx vite preview 或其他任意静态服务器来测试构建结果。
Base Path
如果需要将幻灯片部署到子路由下,需要传入 --base 选项。该路径必须以斜杠 / 开头和结尾,例如:
bash $ slidev build --base /talks/my-cool-talk/
更多细节请参考 Vite 的文档。
输出目录
可以使用 --out 修改输出目录:
bash $ slidev build --out my-build-folder
移除演讲者备注
如果要公开分享构建好的幻灯片且不想包含演讲者备注,可以在构建时加上 --without-notes:
bash $ slidev build --without-notes
多次构建
可以通过传入多个 markdown 文件一次性构建多份幻灯片:
bash $ slidev build slides1.md slides2.md
如果你的 shell 支持,也可以使用 glob 模式:
bash $ slidev build *.md
这种情况下,每个输入文件都会在输出目录中生成一个对应的构建文件夹。
示例
以下是导出 SPA 的一些示例:
- Demo Slides - Composable Vue(作者 Anthony Fu) - 更多请见 Showcases
选项
- ✨ 构建时生成 PDF - ✨ 打包远程资源
托管
我们推荐使用 npm init slidev@latest 来初始化项目,其中包含了托管服务所需的配置文件,开箱即用。
GitHub Pages
要通过 GitHub Actions 将幻灯片部署到 GitHub Pages,请按以下步骤操作:
1. 在仓库中进入 Settings > Pages,在 Build and deployment 下选择 GitHub Actions。(不要选择 Deploy from a branch 然后上传 dist 目录,这种方式不推荐。)另外,configure-pages 中的 enablement: true 选项也可以自动启用 Pages。 2. 创建 .github/workflows/deploy.yml,内容如下,即可通过 GitHub Actions 将幻灯片部署到 GitHub Pages。
deploy.yml
yaml name: Deploy pages
on: workflow_dispatch: push: branches: [main, master]
permissions: contents: read pages: write id-token: write
concurrency: group: pages cancel-in-progress: false
jobs: build: runs-on: ubuntu-latest
steps: - uses: actions/checkout@v7
- uses: actions/setup-node@v6 with: node-version: 'lts/*'
- name: Setup @antfu/ni run: npm i -g @antfu/ni
- name: Install dependencies run: nci
- name: Build run: nr build --base /${{github.event.repository.name}}/
- name: Setup Pages uses: actions/configure-pages@v6 with: enablement: true
- uses: actions/upload-pages-artifact@v5 with: path: dist
deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} needs: build runs-on: ubuntu-latest name: Deploy steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v5
3. 提交并推送更改到仓库。此后每次推送到 main 分支,GitHub Actions 工作流都会自动将幻灯片部署到 GitHub Pages。
之后你可以通过 https://
Netlify
在项目根目录创建 netlify.toml,内容如下:
netlify.toml
toml [build] publish = 'dist' command = 'npm run build'
[build.environment] NODE_VERSION = '24'
[[redirects]] from = '/*' to = '/index.html' status = 200
然后到 Netlify 控制台,用该仓库创建一个新站点即可。
Vercel
在项目根目录创建 vercel.json,内容如下:
vercel.json
json { "rewrites": [ { "source": "/(.*)", "destination": "/index.html" } ] }
然后到 Vercel 控制台,用该仓库创建一个新站点即可。
Zephyr Cloud
要将 Slidev 幻灯片部署到 Zephyr Cloud,可以通过以下命令为现有的 Slidev 项目添加 Zephyr 支持:
bash npx with-zephyr@latest
这个 codemod 会检测你使用的打包器(Slidev 使用 Vite),并更新配置以适配 Zephyr Cloud。
设置完成后,运行正常的构建命令即可,例如:
bash npm run build
启用 Zephyr 后,每次构建都会自动部署应用,并返回一个 Zephyr Cloud 的预览 URL。
INFO
Zephyr Cloud 与大多数托管服务商略有不同:每次构建运行都会触发一次部署。
deed.page
deed.page 无需账号即可托管静态站点。构建好幻灯片后,打包 dist 文件夹,用一次 HTTP PUT 上传即可:
bash npm run build tar -C dist -czf slides.tar.gz . curl -T slides.tar.gz -H "X-Spa: 1" "https://deed.page/v1/sites?slug=my-slides"
X-Spa: 1 请求头会让未知路径也返回 index.html,这样指向具体幻灯片的链接(如 /2 或 /presenter/1)才能正常工作。响应中会包含线上地址 https://my-slides.deed.page/ 和一个 token,之后发布更新时将 token 放在 Authorization: Bearer
Docker 托管
如果你需要用容器快速运行演示文稿,可以使用 tangramor 维护的预构建 Docker 镜像,或者自己构建。
使用 Docker 镜像
只需在你的工作目录中运行以下命令:
bash docker run --name slidev --rm -it \ --user node \ -v ${PWD}:/slidev \ -p 3030:3030 \ -e NPM_MIRROR="https://registry.npmmirror.com" \ tangramor/slidev:latest
注意:可以通过 NPM_MIRROR 指定 npm 镜像源来加快安装速度。
如果你的工作目录是空的,它会在该目录下生成模板 slides.md 及其他相关文件,并在 3030 端口启动服务器。
之后就可以通过 http://localhost:3030/ 访问你的幻灯片了。
要为你的幻灯片制作 Docker 镜像,可以使用以下 Dockerfile:
Dockerfile FROM tangramor/slidev:latest
ADD . /slidev
构建镜像:docker build -t myslides .
然后运行容器:docker run --name myslides --rm --user node -p 3030:3030 myslides
访问 http://localhost:3030/ 即可查看你的幻灯片。