ShowDoc

今天分享的是一款超级好用的文档工具——ShowDoc。
  平时写后台接口,写完给前端工程师用的时候都要提供一份完整的文档,碍于Word写文档比较痛苦,加上我自从认识了Markdown后就爱他爱得不能自拔,写文章要用Markdown,写文档当然也要找一个可以支持Markdown的啊。其实这个工具早就在用了,之前一直用的在线的,但是很多人很多公司都很在乎安全性,你把自己的接口文档放在外网上多少存在隐患的,所以今天在超哥的指导下,在自己电脑上部署了一下。

  • 下载源码
  • 下载WampServer,WampServer就是Windows Apache Mysql PHP集成安装环境,即在window下的apache、php和mysql的服务器软件。
  • 启动服务,测试一下你要使用的端口号,如果端口号被占用了就换一个。


    测试端口号
  • 把ShowDoc的源码放到根目录下
把站点文件夹放到根目录

页面1
页面2

其实我不太会用,就是简单记录一下,下次自己再要搭本地环境的时候可以参考一下。

另外这个ShowDoc使用的数据库是轻量级的sqlite,我也是第一次听说,太孤陋寡闻了,这样是不行的,先记在这里吧。

ShowDoc的官网
ShowDoc的安装手册

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容