ShowDoc

免费的在线API文档、技术文档程序:ShowDoc

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。

比如你公司有什么产品,需要写一份产品帮助文档,方便客户随时查看,减少自己的工作量,那么就可以考虑用ShowDoc来写一份在线文档。

就像下图这种。官方演示地址

ShowDoc演示

ShowDoc的使用方法

ShowDoc分为两种使用方法:直接使用官方提供的在线项目或者自己服务器搭建。

如果需要在线使用,请访问https://www.showdoc.cc/网站创建项目即可。

如果要自己安装,推荐使用自动安装脚本,如下:

  #下载脚本并赋予权限
   wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
  #默认安装中文版。如果想安装英文版,请加上en参数,如 ./showdoc en
  ./showdoc

安装好后,showdoc的数据都会存放在 /showdoc_data/html 目录下。./showdoc 脚本可放置在任何目录,方便以后使用。也可以重新从官方地址下载。

你可以打开 http://xxx.com:4999 来访问showdoc (xxx.com为你的服务器域名或者IP)。账户密码是showdoc/123456,登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。

Scroll to Top