showdoc 开源在线api&&技术文档管理工具

Posted 2021-02-09 rongfengliang

showdoc 是一个很不错的api 以及技术文档管理工具

环境准备

• doker-copose 文件

version: "3"
services:
   doc:
     image: registry.docker-cn.com/star7th/showdoc
     volumes:
     - "./showdoc_data/html:/var/www/html/"
     ports:
     - "8080:80"

启动&&配置

• 启动

docker-compose up  -d

• 拷贝数据

docker-compose exec doc cp -fr /showdoc_data/html/ /var/www/

• 配置
  http://localhost:8080
  效果
  
  登陆
  账户：showdoc/123456
  
  界面效果
  

简单doc 项目

• 创建项目
  
• 添加信息
  简单api 文档

效果

说明

showdoc 的操作还是很简单，方便的，同时内置了一些模版还是很不错的，同时包含了分享、复制，历史版本的功能，以及
团度管理，项目转让，内容本身是基于markdown 编写还是很简单的。

参考资料

https://www.showdoc.cc/help?page_id=65610
https://github.com/star7th/showdoc
https://github.com/rongfengliang/showdoc-docker-compose