star7th/showdoc

ShowDoc 介绍

什么是 ShowDoc？

接手他人开发的模块或项目时，面对满屏没注释的代码，我们常会抓狂——文档在哪？文档在哪？快把文档交出来！
程序员总盼着别人写技术文档，自己却不想动笔。毕竟写技术文档要花大量时间折腾格式排版，还得琢磨新建的 Word 文档该放哪个目录这类非技术细节。
团队里各种 Word 文档分散在不同人手中，需要文档时得靠喊，喊一声要文档，再通过即时通讯或邮件接收。这种沟通方式不算差，但效率实在不高。
ShowDoc 就是为解决这些问题而生的工具——它是 IT 团队在线共享文档的好帮手，能实实在在提升团队成员间的沟通效率。

适用场景

API 文档

随着移动互联网发展，BaaS（后端即服务）越来越普及：服务端提供 API，APP 端或 Web 前端通过调用 API 获取数据。用 ShowDoc 可以快速、方便地编写精美的 API 文档。（示例）

数据字典

一份好的数据字典能清晰地向其他人展示数据库结构，比如每个字段的定义、用途等。ShowDoc 可以轻松实现这一点。（示例）

说明文档

你完全可以用 ShowDoc 编写工具使用说明，或者团队内部的技术规范文档，方便大家随时查阅。（示例）

核心功能

分享与导出

• 响应式网页设计，支持将项目文档分享到电脑或手机端阅读。
• 支持将项目导出为 Word 文档，方便离线浏览。

权限管理

公开项目与私有项目

ShowDoc 项目分两类：

• 公开项目：无需登录，任何人都能访问。
• 私有项目：访问时需输入密码验证，密码由项目创建者设置。

项目转移

项目创建者可将项目自由转移给网站其他用户。

项目成员

可直接添加或删除项目成员。成员有权编辑项目，但无权转移或删除项目（仅项目创建者拥有此权限）。

编辑功能

Markdown 编辑

ShowDoc 采用 Markdown 编辑器，编辑和阅读体验都很流畅。如果不熟悉 Markdown，直接在搜索引擎搜索“Markdown 学习与入门”即可快速上手。

模板插入

编辑页面顶部有模板按钮，点击可直接插入 API 接口模板或数据字典模板。插入后只需修改数据，省去大量重复编辑工作。

历史版本

页面自带历史版本功能，可随时将文档恢复到之前的版本。

部署到自有服务器

ShowDoc 部署

部署方法参考：AutoInstall.md

开发与贡献

开发及贡献指南参考：Development&Contribution.md

版权信息

ShowDoc 基于 Apache2 开源协议发布，可免费使用。
版权所有 © star7th
***：[***已删除]（将 # 替换为 @）
保留所有权利。