强烈推荐一款写文档的好东西
以前不知道有这个东西的存在,下面来宣传不知道的伙伴哈!
官方文档地址如下:https://docsify.js.org/#/zh-cn/quickstart
全局安装:首先安装好node.js
npm i docsify-cli -g
使用国内的安装比较快,cnpm
初始化
进入项目打开命令行,输入
docsify init ./docs
初始化后可以看到目录下有三个文件
index.html
入口文件README.md
会做为主页内容渲染.nojekyll
用于阻止 GitHub Pages 忽略掉下划线开头的文件
直接编辑 docs/README.md
就能更新文档内容,都不用刷新的哈!
你也可以安装Typora,在ty里编辑文档,写好之后直接拉进去就好了,如果不行就重新初始化下再启动。
启动
docsify serve docs
默认端口是3000,另一个窗口再次启动会生成不同的端口。