Docker自建一款快速记录、分享和协作的在线文档工具

院长简介

作者：院长

职位：运维开发工程师

官网：https://deanit.cn

博客：https://blog.deanit.cn

擅长：

【虚拟化，容器化，自动化运维，CICD，监控，日志，中间件，双机热备，分布式存储，数据库，认证，组网隧道，Kali 安全渗透，网络攻击，负载均衡，Html，Css，Js，Jq，Vue3，Shell，Python，Go，前后端框架】

项目地址

GitHub：https://github.com/star7th/showdoc

官网文档：https://www.showdoc.com.cn/help/1385767280275683

项目简介

ShowDoc是一款专为IT团队设计的在线文档工具，它集知识文档与API管理于一体，旨在提升团队内部的沟通效率和文档管理能力。

功能

ShowDoc 是一个非常适合 IT 团队的在线文档分享工具，它可以加快团队之间沟通的效率。通过 showdoc，你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档，你还可以利用 showdoc 的自动化能力，从程序注释中自动生成 API 文档，或者从搭配的 RunApi 客户端（类似 postman 的 api 调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端，有 win 客户端、mac 客户端、ios、android 等，更方便跨平台使用。

目前超过 100000 + 的互联网团队正在使用 showdoc，包括知名公司内部的一些团队，比如腾讯、华为、百度、京东、字节跳动等等。

• 权限管理

• 公开项目与私密项目

  ShowDoc 上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。

• 项目转让

  项目创建者可以自由地把项目转让给网站的其他用户。

• 项目成员

  你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）

• 编辑功能

• markdown 编辑

  ShowDoc 采用 markdown 编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解 Markdown，请在搜索引擎搜索” 认识与入门 Markdown”

• 模板插入

  在 ShowDoc 的编辑页面，点击编辑器上方的按钮可方便地插入 API 接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。

• 历史版本

  ShowDoc 为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。

客户端下载：https://www.showdoc.com.cn/clients

部署安装

安装Docker

curl -sSL https://get.docker.com/ | sh

Docker安装服务

 
sudo docker run -d --name showdoc --user=root \
  --privileged=true -p 4999:80 \
  -v /showdoc_data/html:/var/www/html/ star7th/showdo

Web访问

http://ip:4999

招贤纳士

欢迎👏关注《院长技术》，只做原创，干货～～～