使用轻量应用服务器部署Docsify在线文档平台

编者按:本文来自轻量应用服务器征文活动用户投稿,已获得作者(昵称CS社)授权发布。


无论是出于兴趣爱好需要搭建个人博客,还是工作需要建设信息发布站点,都需要一个信息管理平台或者叫CMS。如果你的经费有限、重在呈现文字内容而不在乎界面,那么本文或许会对你有所帮助——使用阿里云的轻量应用服务器来部署Docsify在线文档平台实现快速建站


Docsify是完全的静态网站,无需费力配置和维护数据库和管理后台。与WordPress、织梦这样的类博客系统相比,Docsify真的很简单,它基于MarkDown文档,可以直接像写文章或说明文档一样写网页,可以说比写WORD都要轻松。用MD文档的形式来管理内容,方便内容的更新、迁移和备份;同时借助阿里云轻量应用服务器的快速部署特性,只需要不到半小时就可以完成快速建站


Docsify官网地址:https://docsify.js.org/#/网站本身就是用Docsify搭建的。作为一个开源项目,Docsify提供了丰富的API,并且具备全文搜索功能。


当然为了方便后期维护站点需要,我们可以先在阿里云轻量服务器上部署宝塔面板作为基础。通过宝塔面板来维护Docsify,非常便捷,解决了文件管理和必要的Web服务配置问题。


接下来看一下详细的部署过程吧~


01 购买服务器并完成初始化


1、创建服务器

选择阿里云的轻量应用服务器。由于我们只是一个信息发布系统,选最低配置就可以满足需求。

使用轻量应用服务器部署Docsify在线文档平台


2、选择宝塔镜像

建议直接使用预装了宝塔面板镜像,这样可以节省我们搭建应用服务的时间。而且宝塔面板非常人性化,免去了配置Linux服务的繁琐步骤。

使用轻量应用服务器部署Docsify在线文档平台


02 配置服务器基础信息


购买完服务器并完成初始化后,就可以设置绑定站点域名并做好ICP备案工作。

使用轻量应用服务器部署Docsify在线文档平台使用轻量应用服务器部署Docsify在线文档平台


可直接在阿里云上申请并设置域名解析。主机名就是域名前缀,默认的主机名一般是www(万维网),而@就是无域名前缀。添加A记录指向你租用的阿里云轻量服务器的公网地址,IP填在记录值里。当然你也可以添加其他字母数字组合作为主机名,实现分站点。

使用轻量应用服务器部署Docsify在线文档平台


03  宝塔面板配置


1、安全设置

在点击应用部署首页进入宝塔面板后,可以非常方便的管理Linux服务器。由于可以通过Web直接从公网访问到,因此建议进行安全设置,指定端口号。这样可以降低服务器被黑客的自动扫描脚本检测到和被入侵的风险。同时设置安全入口相当于在用户密码前加了一道锁,进一步提高安全性。

使用轻量应用服务器部署Docsify在线文档平台


需要注意由于面板的访问端口发生改变,需要同时修改阿里云轻量防火墙的策略,否则页面无法访问。设置的端口号需与宝塔面板的端口号一致。

使用轻量应用服务器部署Docsify在线文档平台


2、WEB服务配置

启动网站服务前,需要先安装WEB服务,建议选择宝塔面板中软件商店里的Nginx 服务,相比Tomcat占用内存很少,性能更好,更适合轻量应用服务器。安装之后别忘了点击启动服务。

使用轻量应用服务器部署Docsify在线文档平台


之后就可以选择网站选项,添加网站站点,输入注册好的域名主机名。需要注意的是网站的根目录位置,稍后我们需要将内容网页上传到这个目录下

使用轻量应用服务器部署Docsify在线文档平台


我之前已经设置好了DNS域名解析,就可以直接在浏览器中输入配置好的域名网址进行访问。看到下图说明宝塔面板上的web网站配置已生效。

使用轻量应用服务器部署Docsify在线文档平台


3、通过宝塔面板上传项目

虽然FTP是常用的网站上传工具,但宝塔的文件功能非常适合作为网站管理工具。直接选择宝塔面板主菜单上的文件选项,点击上传,选择本地网站文件或目录上传即可。

使用轻量应用服务器部署Docsify在线文档平台


04  通过Node.js在本地生成Docsify项目


完成服务器的配置后,我们需要先在本地生成Docsify项目。由于Docsify这个JavaScript前端开源项目本身托管在Node.js的NPM包管理器上,所以生成Docsify前需要先安装Node.js。


1、安装Node.js

首先确定你的电脑上安装了Node.js,建议安装LTS(长期支持稳定版)的16.13版。

使用轻量应用服务器部署Docsify在线文档平台


2、NPM镜像源切换

由于Node.js的NPM包管理器在*下载速度偏慢,建议先安装好Node.js后,先切换NPM源到国内的镜像。比如淘宝的CNPM服务器。在命令行中完成切换:


npm install -g cnpm --registry=https://registry.npm.taobao.org


安装之后若看到下方截图说明安装CNPM成功:

使用轻量应用服务器部署Docsify在线文档平台


3、用CNPM工具安装docsify-cli

在命令行中输入下方指令:


cnpm i docsify-cli -g


安装之后若看到下方截图说明安装Docsify成功:

使用轻量应用服务器部署Docsify在线文档平台


4、切换到你需要的目录下,生成Docsify项目

在命令行中输入下方指令:


docsify init ./docs


如果初始化成功会弹出下面的提示:

使用轻量应用服务器部署Docsify在线文档平台


在你指定的目录下生成Docsify的初始页面文件。

使用轻量应用服务器部署Docsify在线文档平台


5、查看项目页面效果

在命令行中输入下方指令:


docsify serve ./docs


这时如果返回下面的提示,说明服务已启动可以查看效果了。

使用轻量应用服务器部署Docsify在线文档平台


打开浏览器就可以看到一个空白的初始Docsify文档站已经建成了。

使用轻量应用服务器部署Docsify在线文档平台


05  编辑和配置Docsify项目


我们的站点不能只有一行主题词,需要为站点添加内容。最简单的方法是直接编辑项目docs目录下的README文档,保存文档并刷新浏览器之后,你编辑的内容会直接呈现在网页中。MarkDown的段落和语法非常好理解,建议直接看官方文档:

https://www.markdownguide.org/basic-syntax/


当然Docsify的高级功能比如侧边栏、导航栏和搜索框等功能都需要在docs目录下的index.html中进行配置才会生效。


1、 配置侧边栏和导航栏

通过在index.html中的script的window.$docsify中插入以下代码可以开启相关功能。


name: '导航目录',
loadSidebar: true,//开启侧边栏
subMaxLevel: 3,   //目录最大级数
maxLevel: 4,      //可配置最大支持渲染的标题层级


开启之后会出现如下图所示的侧边栏,可以显示多级标题:

使用轻量应用服务器部署Docsify在线文档平台


2、 配置全文搜索栏目

需要先在index.html中添加引用Docsify搜索插件的代码:


<script src="//cdn.bootcss.com/docsify/4.5.9/plugins/search.min.js"></script>


然后再通过在index.html中script的window.$docsify中加入以下代码可以实现:


search: {//添加搜索功能,中文和英文文档同时搜索
paths: 'auto',
placeholder: {
'/':'???? 搜索',
},},//增加搜索框


开启之后会出现如下图所示的搜索栏,实现全文搜索:

使用轻量应用服务器部署Docsify在线文档平台



3、 拓展资源推荐

由于Docsify是一个开源项目,所以在Github上可以搜索到大量的相关丰富的插件和样例。以下两个网址供读者自己去探索拓展(点击即可跳转):

项目展示

插件下载


总结:

很多大公司都在用Docsify去做一些企业级的应用,对于个人用户而言,它也是是一个“万金油”的宝藏,可以用来做个人博客、说明文档、程序或代码管理等很多事情。希望上面的教程能够抛砖引玉,期待大家解锁轻量应用服务器更多实用、好玩的功能。


点击参与体验,查看轻量应用服务器更多的产品及活动信息。

上一篇:python环境安装


下一篇:摩根大通亚太区CEO欧冠昇: 打造4万人科研团队,主攻区块链和大数据