想要写文档吗?那你不妨试试docsify吧——Windows部署教程

写文档的话虽然像Wordpress什么的都可以写,但是总难免会觉得少了些什么东西

Gitbook虽然很不错,但是用官方的服务器一是真心慢(更何况现在Github在大陆的连接情况也是相当的糟糕),二是自己部署又相当的麻烦(至少我自己部署的时候就各种翻车= =)

那么,我们为什么不换一个玩具来尝试下呢?

部署docsify有两种方式,一种是直接静态部署到自己的服务器上

第二种是按照官方给出的使用NodeJS进行安装

在这里我们以Windows为例进行安装说明

使用静态文件快速部署

首先是一个仓库链接:https://github.com/KJZH001/docs

在这里有我给出的一些实列,当然你也可以直接拿去用。此外,这里顺便说一下,docsify支持使用Github Pages进行部署

Web服务器 部署教程

请在你的Web服务器中新增一个站点,使用的是Apache、Nginx、IIS都没关系

然后在你的对应网站目录中,打开Git Bash

执行以下代码(可能需要科学上网)

git init
git remote add origin https://github.com/KJZH001/docs.git
git pull origin master

此时,你就可以尝试访问你的站点查看部署是否成功了


Github Pages部署教程

考虑到可能有些新手刚刚接触到Github不太熟悉,所以在这里也简单说一下如何部署

在打开上述仓库,点击右上角的Fork按钮,然后你的Github账户下就会有一个一模一样的仓库了

然后打开仓库的Settings,左侧有一个Pages二级菜单,我们打开,在这里就可以启动你的Github Pages服务了

如果你希望使用github分配的域名的话,请删除下方的自定义域名


使用NodeJS进行部署

说实话,我个人其实并不建议使用这种方式,因为这个东西本质上只是一个用js实时渲染Markdown的Web程序而已

除非你的目标服务器上没有其他现成的Web环境或者有特殊需求,其实并不建议你使用这种方式进行部署


首先,你需要获取NodeJS(废话)

Nodejs官网:https://nodejs.org/en/

下绿色版或者安装版都可以,不过我个人更推荐使用绿色版,这样可以方便移动或者在不想要用的时候直接删除

在你的Node目录下,输入以下指令进行安装

npm i docsify-cli -g

在安装完成以后,你可以输入以下命令对你希望使用的目标目录进行初始化

docsify init ./docs

然后你就可以输入这条命令启动Web服务,在chrome等浏览器中打开http://localhost:3000,就能进行实时效果预览了

docsify serve docs

开始使用

你所需要编写的Markdown文件位于和index.html同级目录下的readme.md中

也就是在Github仓库一开始打开就能够看到的那个自述文件

此外docsify也支持更换主题,你只需要使用第三方的css替换掉默认的css即可

最后

这大概算是这两个月的咕咕咕以来第一次的更新吧(

也是我第一次在学校里写正儿八经的文章....不过这写的好像也蛮水的,一张图也没有配,而且也是完完全全的凭借记忆写下来的玩意,不知道有没有错的

那么,也就先这样吧~

快到五一了,我们据说会放近4天哦,不知道你们怎么样呢

先祝大家五一假期快乐!

点赞
  1. Magma说道:
    Google Chrome Windows 10
    新玩具( 如果仅仅是写文档而不追求什么的话 语雀实际上也挺好用的
    1. 晓空说道:
      QQbrowser Windows 7
      主要是有些时候还是部署在自己服务器上更安心点 :huaji:
      而且代码在自己这里可以来搞更高程度的美化 :huaji13:
      虽然语雀之类的也确实很香就是了 :huaji14:

Magma进行回复 取消回复

电子邮件地址不会被公开。必填项已用 * 标注