侧边栏网站模板-Wiki系列(二):docsify部署与配置

上一篇文章选择了docsify作为我的Wiki系统。 本文将讲一下docsify的部署和配置。

官方推荐部署

docsify 快速入门文档:#/quickstart

快速开始

安装 docsify-cli 工具:

npm i docsify-cli -g

初始化项目:

docsify init ./docs

预览站点:

docsify serve docs

部署到服务器

docsify 部署文档:#/deploy

您可以选择部署到以下服务:

我自己的部署初始化项目

我在本地使用官方的重构工具来初始化项目:

docsify init wiki

虽然初始化后有三个文件,index.html、README.md、.nojekyll。

本地编辑文档后,可以使用以下命令在本地预览:

docsify serve wiki

上传到Git

添加文档后侧边栏网站模板,我将整个wiki文件夹上传到“Gitee”。 我为什么选择Gite? 当然,访问国外是快速且免费的。

部署到 Nginx

登录我的服务器并生成 SSH 公钥。 生成方法请参考“生成/添加SSH私钥”,然后添加到Gitee的“SSH公钥”中。

然后使用git拉取服务器上的Wiki项目。 当然,你需要使用SSH地址。 本地文档更新推送到Gitee后,只需在服务器上拉取更新即可。

拉取后,配置Nginx如下,即可通过域名访问:

server {
  listen 80;
  server_name  wiki.juemuren4449.com;
    location / {
      try_files $uri $uri/ /index.html;
      root /usr/local/wiki;
      index  index.html index.htm;
      add_header Cache-Control "no-cache, no-store";
  }
}

缓存的设置因人而异。 我的个人Wiki才刚刚开始积累,还在建设中。 如果允许缓存,则可能无法显示最新更新的内容。 以后搭建的时候应该设置允许缓存侧边栏网站模板,或者直接放就可以了。 在 CDN 上。

为什么不使用 CDN

由于docsify构建的Wiki都是源文件,不需要自己编译,所以可以将整个文档放在优拍云或者七牛云等CDN上,访问速度会更快。

但目前我还是将Wiki部署在我的服务器上,为什么不直接放在CDN上,有几个原因:

如果使用默认的routerMode,放在CDN上是完全可行的。

自定义配置

docsify 自定义配置文档:#/configuration

所有配置都在window.$docsify中。

我添加了以下配置,更多配置请参考上面的文档链接。

加载侧边栏

加载自定义侧边栏,请参阅#/more-pages 了解详细信息。

loadSidebar: true,

添加_sidebar.md文件,文件格式写入如下:

- [CentOS](centos.md)
- [Docker](docker.md)
- [Mac](mac.md)
- [NPM](npm.md)
- [推荐](recommend.md)

次最高级别

自定义侧边栏后,默认不会生成目录。 您需要通过设置生成目录的最大级别来启用该功能。

subMaxLevel: 2,

使用loadSidebar,效果如下:

自动2顶

切换页面后是否手动跳转到页面底部。

auto2top: true,

姓名

文档标题,显示在侧边栏底部。

name: '掘墓人的 Wiki',

名称链接

点击文档标题后跳转的链接地址。

nameLink: '/',