docsify使用说明

docsify使用说明

Posted by wenfengSAT on December 29, 2019

docsify使用说明


一、Linux下安装node

1、下载node安装包

下载node7跟node8的安装包

curl --silent --location https://rpm.nodesource.com/setup_8.x | bash -

curl --silent --location https://rpm.nodesource.com/setup_7.x | bash -

2、安装node

yum install -y nodejs

3、检查node安装情况

node -v

二、安装docsify插件

1、安装 docsify-cli 工具

npm i docsify-cli -g

执行之后等几分钟,时间看网速


2、如果已经有docsify项目,切到docsify项目目录下,运行

docsify serve  项目路径 -p 运行端口

例: docsify serve /data/docs/pay-docs -p 8080

部署到服务器命令:
nohup docsify serve /data/docs/pay-docs -p 8080 &

注意:端口不能冲突


3、部署扩展

也可直接将生成的文档放到nginx或者Tomcat容器里运行

三、参考资料

docsify参考模板:
https://gitee.com/daskj/docs-template
http://daskj.gitee.io/docs-template/#/

https://github.com/Q-Angelo/Nodejs-Roadmap
https://www.nodejs.red/#/


官网:
https://docsify.js.org/#/



四、windows下预览体验


1、启动tomcat
2、到tomcat  webapps目录下git clone http://10.219.11.60/public-show/api-docs/
3、访问浏览器localhost:端口/redis


五、使用模板编写文档注意事项(针对http://10.219.11.60/public-show/api-docs/ 下的文档说明)


1、文件说明

index.html  : 文档主页
_sidebar.md :定义文档目录
README.md :文档首页内容
kslj.md :快速了解内容
kskf.md :开始开发内容
kfsc.md :开发手册内容
cjwt.md :常见问题内容

2、注意事项

md文件内容格式按照markdown语法