部署

和 GitBook 生成的文档一样，我们可以直接把文档网站部署到 GitHub Pages 或者 VPS 上。

GitHub Pages

GitHub Pages 支持从三个地方读取文件

  • docs/ 目录
  • master 分支
  • gh-pages 分支

我们推荐直接将文档放在 docs/ 目录下，在设置页面开启 GitHub Pages 功能并选择 master branch /docs folder 选项。

github pages

!> 可以将文档放在根目录下，然后选择 master 分支 作为文档目录。

GitLab Pages

如果你正在部署你的主分支, 在 .gitlab-ci.yml 中包含以下脚本：

?> .public 的解决方法是这样的，cp 不会无限循环的将 public/ 复制到自身。

  1. pages:
  2.   stage: deploy
  3.   script:
  4.   - mkdir .public
  5.   - cp -r * .public
  6.   - mv .public public
  7.   artifacts:
  8.     paths:
  9.     - public
  10.   only:
  11.   - master

!> 你可以用 - cp -r docs/. public 替换脚本, 如果 ./docs 是你的 docsify 子文件夹。

VPS

和部署所有静态网站一样，只需将服务器的访问根目录设定为 index.html 文件。

例如 nginx 的配置

  1. server {
  2.   listen 80;
  3.   server_name  your.domain.com;
  5.   location / {
  6.     alias /path/to/dir/of/docs;
  7.     index index.html;
  8.   }
  9. }