查看“Docsify 部署”的源代码

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

<span id="github-pages"></span>
== GitHub Pages ==

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

* <code>docs/</code> 目录
* master 分支
* gh-pages 分支

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

!&gt; 可以将文档放在根目录下，然后选择 '''master 分支''' 作为文档目录。你需要在部署位置下放一个 <code>.nojekyll</code> 文件（比如 <code>/docs</code> 目录或者 gh-pages 分支）

<span id="gitlab-pages"></span>
== GitLab Pages ==

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

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

<pre lang="yaml">pages:
  stage: deploy
  script:
  - mkdir .public
  - cp -r * .public
  - mv .public public
  artifacts:
    paths:
    - public
  only:
  - master</pre>
!&gt; 你可以用 <code>- cp -r docs/. public</code> 替换脚本, 如果 <code>./docs</code> 是你的 docsify 子文件夹。

<span id="gitee-pages"></span>
== Gitee Pages ==

在对应的 Gitee 仓库服务中选择 <code>Gitee Pages</code>，选择您要部署的分支，填写您要部署的分支上的目录，例如<code>docs</code>，填写完成之后点击启动即可。

<span id="vps"></span>
== VPS ==

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

例如 nginx 的配置

<pre lang="nginx">server {
  listen 80;
  server_name  your.domain.com;

  location / {
    alias /path/to/dir/of/docs/;
    index index.html;
  }
}</pre>
<span id="netlify"></span>
== Netlify ==

# 登陆你的[https://www.netlify.com/ Netlify]账号
# 在[https://app.netlify.com/ dashboard]页上点击 '''New site from Git'''
# 选择那个你用来存储文档的git仓库，将 '''Build Command''' 留空, 将 '''Publish directory''' 区域填入你的<code>index.html</code>所在的目录，例如：填入<code>docs</code>(如果你的<code>index.html</code>的相对路径是<code>docs/index.html</code>的话)

<span id="html5-路由"></span>
=== HTML5 路由 ===

当使用HTML5路由时，你需要设置一条将所有请求重定向到你的<code>index.html</code>的重定向规则。当你使用Netlify时这相当简单，在你的'''Publish Directory'''下创建一个<code>_redirects</code>文件，写进以下内容就可以了 :tada:

<pre lang="sh">/* /index.html 200</pre>
<span id="zeit-now"></span>
== ZEIT Now ==

# 安装 [https://zeit.co/download Now CLI] ： <code>npm i -g now</code>
# 切换到你的 docsify 网站的文档目录，例如 <code>cd docs</code>
# 用一个指令来部署： <code>now</code>

<span id="aws-amplify"></span>
== AWS Amplify ==

# 在 Docsify 项目的 <code>index.html</code> 中设置 routerMode 为 ''history'' 模式：

<pre lang="html"><script>
    window.$docsify = {
      loadSidebar: true,
      routerMode: 'history'
    }
</script></pre>
<ol start="2" style="list-style-type: decimal;">
<li>登录到你的 [https://aws.amazon.com AWS 控制台]。</li>
<li>到 [https://aws.amazon.com/amplify AWS Amplify 仪表盘]。</li>
<li>选择 '''Deploy''' 路线来设置你的项目。</li>
<li>若有提示，如果你希望在项目根目录下保存你的文档，保持构建设置为空；如果你想保存文档到其它目录，修改<code>amplify.yml</code>:</li></ol>

<pre class="yml">version: 0.1
frontend:
  phases:
    build:
      commands:
        - echo &quot;Nothing to build&quot;
  artifacts:
    baseDirectory: /docs
    files:
      - '**/*'
  cache:
    paths: []</pre>
<ol start="6" style="list-style-type: decimal;">
<li>依次添加如下跳转规则。注意第二条的 PNG 是图片格式，如果你要使用其它图片格式，可以相应修改。</li></ol>

{| class="wikitable"
|-
! Source address
! Target address
! Type
|-
| /&lt;*&gt;.md
| /&lt;*&gt;.md
| 200 (Rewrite)
|-
| /&lt;*&gt;.png
| /&lt;*&gt;.png
| 200 (Rewrite)
|-
| /&lt;*&gt;
| /index.html
| 200 (Rewrite)
|}

<span id="docker"></span>
== Docker ==

* 创建 docsify 的文件

你需要准备好初始文件，而不是在容器中制作。 请参阅快速开始部分，了解如何手动或使用 [https://github.com/docsifyjs/docsify-cli docsify-cli] 创建这些文件。

<pre lang="sh">index.html
README.md</pre>
* 创建 Dockerfile

<pre lang="dockerfile">FROM node:latest
LABEL description="A demo Dockerfile for build Docsify."
WORKDIR /docs
RUN npm install -g docsify-cli@latest
EXPOSE 3000/tcp
ENTRYPOINT docsify serve .</pre>
创建成功后当前的目录结构应该是这样的：

<pre lang="sh">index.html
README.md
Dockerfile</pre>
* 构建 docker 镜像

<pre lang="sh">docker build -f Dockerfile -t docsify/demo .</pre>
* 运行 docker 镜像

<pre lang="sh">docker run -itp 3000:3000 --name=docsify -v $(pwd):/docs docsify/demo</pre>