今天试着搭建一个文档平台。
环境要求:安装npm环境
1、首先是在命令行安装全局docsify,命令如下
npm i docsify-cli -g
我在安装执行这个命令之后,发现命令行窗口一直不会动,没有那种正在下载的迹象,但是我还是等了十几分钟,后来发现不对,这可能根本没在下载,后来,果然出现了一段提示
npm WARN registry Unexpected warning for https://registry.npmjs.org/: Miscellaneous Warning EAI_AGAIN: request to https://registry.npmjs.org/minimist failed, reason: getaddrinfo EAI_AGAIN registry.npmjs.org:443
npm WARN registry Using stale package data from https://registry.npmjs.org/ due to a request error during revalidation.
[ ...............] / fetchMetadata: sill resolveWithNewModule ansi-regex@2.1.1 checking installable status
我就上网查了一下,发现好像是什么npm代理之类的没有设置,我就抱着试一试的态度,执行了以下3个命令
npm config get proxy
执行完上面的命令,会返回null打印在控制台,再执行下面的命令
npm config get https-proxy
执行完上面的命令,也会返回null打印在控制台,再执行下面的命令
npm config set registry http://registry.cnpmjs.org/
之后就可以了愉快的安装docsify了
如果在第一个命令和第二个命令没有返回null的话,可以使用下面的命令,将这两个值都手动置为null
npm config set proxy null
npm config set https-proxy null
2、新建一个文件夹docsify-demo,用于存储dosify的项目,进入这个项目文件夹,执行docsify init ./,那么文件夹下面就会新增3个文件,之后在该文件夹下使用命令行执行docsify serve ./,就可以通过浏览器访问http://localhost:3000/看到效果了。
3、如果不想自己建立空项目,那么也可以不执行第2步,直接到大佬的github下载demo文件夹:https://github.com/Snailclimb/docsify-demo
之后执行在该文件夹下docsify serve ./,就可以通过浏览器访问http://localhost:3000/,看到效果如下:
4、为项目添加github跳转连接,打开index.html文件,修改下面的地址
将下面的地址修改为你要跳转的链接即可。之后在项目的每一个页面中,右上角都有一个跳转链接,如下
5、将项目部署到github
新建一个github仓库,然后把项目提交上去,再去仓库设置中修改github pages,如下
6、将项目同步到码云
登录之后创建仓库选择从github导入,导入之后,选择gitee Pages服务。之后即可愉快通过外网访问到你的文档平台项目,https://freshbin.gitee.io/docsify-demo/#/如下:
docsify网站:https://docsify.js.org/#/quickstart