朗读

vue-docute构建线上文档

文章目录[x]
  1. 1:1.安装(npm安装)

不需要额外的安装设置,无需构建过程,即可编写文档。

Docute

今天浏览网页的时候,发现了这个docute。感觉它和gitbook、看云具有相似的UI,但是docute不需要生成静态html文件,并且配置更少,同时仍保留了用于编写精美文档的最有用功能。确实感觉很实用。

为什么说很实用 :一个系统开发完成了总要有操作说明手册,接口文档之类的东西吧?这个时候就可以用decute。

部署:可以部署到vbs、或者github上

插件:支持搜索、评论(需要自己配置)

官方网址:https://v3.docute.org/#/

官方使用文档:https://v3.docute.org/#/home

小生构建的效果图

1.安装(npm安装)

可以用git bash here或者cmd命令窗口安装,先新建一个空白文件夹,我这里c:\decute

进入文件夹,鼠标右击,打开git bash here窗口

在窗口中输入下面命令(这里下载有可能失败,网络问题,最好挂一下加速器)

npm i -g docute-cli
yarn global add docute-cli

这里如果提示yarn找不到命令的话就安装一下

npm install yarn

然后执行下面的命令开始服务,这里的docute可能无法找到命令,这是因为没有增加到环境变量里。加一下就可以了

这里我的目录如下图所示

docute ./docs
然后打开 http://localhost:8080 查看运行结果,如果报错可能是8080端口被占用(比如我的本地8080端口就被apess]不需要额外的安装设置,无需构建过程,即可编写文档。
docute ./docs -p 2020

下面就可以直接访问了

第一个图片是引导页,需要自己加(我这里只加好的)

 

刚刚进去的时候应该就一个空白页面,一些设置需要自己慢慢加

 

具体加搜索,或者配置其他的话,可以参照官方文档(里面讲的很全,小生这水平就不再说了)

点赞

发表评论

昵称和uid可以选填一个,填邮箱必填(留言回复后将会发邮件给你)
tips:输入uid可以快速获得你的昵称和头像

Title - Artist
0:00