# open-doc **Repository Path**: xiayoumo/open-doc ## Basic Information - **Project Name**: open-doc - **Description**: 文档工具 - **Primary Language**: PHP - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-09-20 - **Last Updated**: 2025-02-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ### OpenDoc是什么 OpenDoc源于开源项目[showDoc](https://www.showdoc.com.cn/ "showDoc")早期开源版本,升级了前端手脚架版本，用户交互体验重构，以及新增服务功能（支持word编辑器，快速导航，共享excel,可视化文档以及文件夹管理等），是一个更适合 企业团队(或个人）的在线文档（包括api文档）管理工具。 ### 示例官网 [OpenDoc](https://www.opendoc.cc/show/index "OpenDoc") ### 它可以用来做什么 ##### 共享文档 [（ 查看示例 ）](https://www.opendoc.cc/item-show/35?page_id=3962 "（ 查看示例 ）") opendoc支持在线共享文档,也可以编写一些收集团队信息的excel文档以供团队填写 ##### 说明文档 [（ 查看示例 ）](https://www.opendoc.cc/item-show/35?page_id=3952 "（ 查看示例 ）") 你完全可以使用opendoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅 ##### API文档 [（ 查看示例 ）](https://www.opendoc.cc/item-show/35?page_id=3930 "（ 查看示例 ）") 随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用OpenDoc可以非常方便快速地编写出美观的API文档。 ##### 数据字典 [（ 查看示例 ）](https://www.opendoc.cc/item-show/35?page_id=3931 "（ 查看示例 ）") 一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。 #### 它都有些什么功能 ##### 分享与导出 响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件，以便离线浏览。 ##### 权限管理 公开项目与私密项目 OpenDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置 ##### 项目转让 项目创建者可以自由地把项目转让给网站的其他用户。 ##### 项目成员 你可以很方便地为OpenDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限） ##### 团队管理 利用OpenDoc的团队功能你可以更好地进行团队协作 ##### 编辑功能 word文档编辑/markdown编辑/excel编辑 OpenDoc同时支持两种编辑器（markdown/word/excel），无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown” ##### 模板插入 在OpenDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板等。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。 ##### 历史版本 OpenDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。 ##### 自动化 可从代码注释中自动生成文档 搭配的RunApi客户端，可调试接口和自动生成文档 使用在线的OpenDoc 如果你没有自己的服务器，但又想使用OpenDoc作为文档分享工具，你可以使用在线的OpenDoc [（ 点击前往 ）](https://www.opendoc.cc/item/index "（ 查看示例 ）") 在线opendoc作为在线服务会长期维护，请放心托管数据 ##### 部署到自己的服务器 OpenDoc部署手册请参考：[点此查看](https://www.opendoc.cc/item-show/36?page_id=3935 "点此查看") 开源地址：[点此查看](https://github.com/xiayoumo/open-doc "点此查看") （国内镜像 [点此查看](https://gitee.com/xiayoumo/open-doc "点此查看") ）。若觉得OpenDoc好用，不妨点个star。良好的关注度和参与度有助于开源项目的长远发展。 ##### 二次开发指引 [点此查看](https://www.opendoc.cc/item-show/36?page_id=3942 "点此查看")