在线文档分享工具ShowDoc

在 《在线文档系统MrDoc》 中,我们提到过另一款在线文档 ShowDoc

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

title

ShowDoc 客户端支持主流的平台

title

对于手机app,如果你正在使用 www.showdoc.com.cn ,则下载即可使用。如果你是使用私有版showdoc,则请登录手机app的时候,在页面右上角指定私有版showdoc的服务器地址(私有版showdoc服务端需要更新到最新代码)

安装

在群晖上以 Docker 方式安装。

在注册表中搜索 showdoc ,选择第一个 star7th/showdoc,版本选择 latest

docker 文件夹中,创建一个新文件夹,并将其命名为 showdoc,然后在 showdoc 文件夹中再创建一个新的子文件夹,命名为 html

文件夹 装载路径
docker/showdoc/html /var/www/html/

title

端口

要避免端口冲突,所以重新指定了本地端口

本地端口 容器端口
4999 80
4943 443
4900 9000

运行

在浏览器中输入 http://群晖:4999,第一次会有语言选择设置,默认是 中文

安装成功后会显示默认的账号和密码

进入网站首页

转到 登录/注册 界面

用默认的账号(showdoc)和密码(123456)登录,可以看到官方提供的4种模板。

title

建议在后台管理中修改管理员的默认密码

新建项目

title

复制项目,可以从 4 种模板中直接复制

title

可以 导入文件

title

还能 自动生成

title

新建一个项目

管理目录

编辑页面,可以利用现有的模板

也可以自己建模板

ShowDoc 不仅安装简单,使用也很简单,稍微熟悉下即可上手了。

参考文档

star7th/showdoc: 代码
地址:https://github.com/star7th/showdoc

ShowDoc 官网
地址:https://www.showdoc.com.cn/

帮助说明–ShowDoc
地址:https://www.showdoc.com.cn/help