showdoc README

The project's README from github.com/star7th/showdoc. As one markdown file: README.md.

ShowDoc

中文教程

What is ShowDoc?

When you take over a module or project that was developed by someone else, reading code without any notes or comments can be painful.

Where is the documentation?! Show me the doc!

Programmers often expect others to write technical documentation, but rarely want to write it themselves. Writing good technical documentation takes a lot of time and effort, and involves a great deal of non-technical work, such as deciding on the format and layout, or figuring out which catalog a new Word document should be filed under.

In most teams, Word documents are maintained separately by different people.

How do you get the latest version of a document? Here is a common approach:

You ask around for it. If you're lucky, someone will send you a copy over IM or email. This works, but it is far from the most efficient way.

So, what is the most efficient way? ShowDoc!

ShowDoc is a tool designed for IT teams to share documents online. It improves communication efficiency among team members.

What can it be used for?

What features does it have?

Deploy it on your own server

ShowDoc is released under the Apache 2.0 Open Source License and is free to use.

In addition to the Apache 2.0 license, ShowDoc carries an extra copyright notice:

showdoc (star7th/showdoc)

Searching Database…

12.9K ·GitHub
这是什么?ShowDoc 是一款可自行部署的工具,供 IT 团队编写和分享在线文档,尤其适用于 API 文档、数据字典和技术规范。
这是文档编辑器,还是更像 Wiki 平台?这是一个基于网页的文档平台,提供 Markdown 编辑器、按项目组织内容、权限管理和版本历史功能,更像是专注于 API 文档的轻量版 Confluence。
我该如何在自己的服务器上部署 ShowDoc?您可以按照 AutoInstall.md 指南自行部署;仓库中也提供了 Docker 和 docker-compose 配置。
它用什么技术栈运行?ShowDoc 使用 PHP 开发,通常部署在 Nginx 或 Apache 后面,默认数据库为 SQLite。
自行部署时有哪些安全隐患吗?有的。如果您使用 Nginx 或 Apache 自行部署,必须屏蔽对 Sqlite/ 目录的访问,否则您的实例将存在远程代码执行漏洞。
我能让文档保持私密吗?可以。项目可设置为私有,只有登录且拥有项目密码的用户才能查看;公开项目则任何人都可以查看。
我能导出文档以便离线使用吗?可以,项目可以导出为离线 Word 文档,同时也支持在网页和移动端自适应阅读。
它能帮我更快地编写 API 文档吗?可以,编辑器支持一键插入 API 接口和数据字典模板,您只需填写数据即可。
多人能同时编辑同一个项目吗?可以,您可以添加可编辑文档的项目成员;不过只有所有者能转让或删除项目,项目所有权本身也可以转让。
如果有人把文档改乱了,我能恢复旧版本吗?可以,ShowDoc 会为每个页面保留版本历史,您可以恢复到之前的版本。
What are similar projects?docs, Trilium, AFFiNE, outline, docmost, siyuan, BookStack, quarkdown
Creator
star7th
Size
46.2 MB
Stars
12.9K
Age
10y
Commits · 90 Days