unity3d api 中文文档_接口文档系统-showdoc安装部署

ShowDoc简介

1. ShowDoc是一个开源、免费的工具
2. ShowDoc是一个非常适合IT团队的在线API文档，技术文档工具，它可实现实时同步，用户无需花费过多的精力维护文档。
3. 借助ShowDoc可以方便，快速地编写出美观的API文档，并且还可以用它编辑数据字典，说明书和一些技术规范说明文档共团队查阅。
4. ShowDoc提供免费在线文档托管服务，用户可以通过ShowDoc官网创建自己的项目，并将其保存在云端，也可以选择将ShowDoc部署在本地服务器。

ShowDoc部署

1. linux服务器

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

安装后说明：

安装好后，showdoc的数据都会存放在 /showdoc_data/html 目录下。./showdoc 脚本可放置在任何目录，方便以后使用.你可以打开 http://xxx.com:4999 来访问showdoc (xxx.com为你的服务器域名或者IP)。账户密码是showdoc/123456，登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。

2. mac上部署

1. 安装Docker   brew cask install docker2. 安装git   首先查看电脑是否安装Git，终端输入:   git

git

要是没有安装就进行安装:   brew install git3. 下载ShowDoc源码   git clone -o github https://github.com/star7th/showdoc4. 进入showdoc目录开始安装   cd /showdoc //创建showdoc目录   docker build -t showdoc ./5. 启动showdoc服务   docker run -d --name showdoc -p 4999:80 showdoc6. 访问showdoc   在浏览器中输入网址：http://127.0.0.1:4999/install/

Showdoc install 页面

选择语言(默认选择中文),单击'OK'按钮，弹出框提示安装成功

installSucc