三年前我也在写 hybrid app，也是自己写服务器。其实何止，包含 web 端，微信公众号端都是我写。其动力不来源于技术，与技术无关，与探索欲折腾欲无关，只是因为当时有不少人用我的产品，我想做得更好而已。

有些人的时间成本注定很低的，大概是他们不能用时间来创造相应的价值。他们宁愿花各种时间各种折腾各种低效率，也不想花一两百 /年 去买稳定。如果是学生还能理解，如果是工作了的人，就别在贪小便宜这件事上困住自己。

### ShowDoc 是什么

每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！**Show me the doc ！！**

程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的 word 文档放在哪个目录等各种非技术细节。

word 文档零零散散地放在团队不同人那里，需要文档的人基本靠吼，吼一声然后上 qq 或者邮箱接收对方丢过来的文档。这种沟通方式当然可以，只是效率不高。

ShowDoc 就是一个非常适合 IT 团队的在线文档分享工具，它可以加快团队之间沟通的效率。

### 它可以用来做什么

- API 文档（ [查看 Demo]( http://www.showdoc.cc/2)）

随着移动互联网的发展，BaaS （后端即服务）越来越流行。服务端提供 API，APP 端或者网页前端便可方便调用数据。用 ShowDoc 可以非常方便快速地编写出美观的 API 文档，同时还将支持从代码文件中自动生成 API 文档

- 数据字典（ [查看 Demo]( http://www.showdoc.cc/1)）

一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

- 说明文档（[查看 Demo]( http://www.showdoc.cc/3) ）

你完全可以使用 showdoc 来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

### 它都有些什么功能


- ** 分享与导出 **

- 响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成 word 文件，以便离线浏览。

- ** 权限管理 **
- 公开项目与私密项目

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

- 项目转让

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

- 项目成员

你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）
- 团队管理
你可以自行添加多个团队，为团队分配不同的项目，同时设置团队里每个人的权限。

- ** 编辑功能 **
- markdown 编辑

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

- 模板插入

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

- 历史版本

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


### 安装到自己的服务器


- 安装手册：[https://www.showdoc.cc/help?page_id=13732]( https://www.showdoc.cc/help?page_id=13732)
- 若觉得 showdoc 好用，不妨点个 star。良好的关注度和参与度有助于开源项目的长远发展。开源地址： https://github.com/star7th/showdoc



### 使用在线的 ShowDoc

- 如果你没有自己的服务器，但又想使用 ShowDoc 作为分档分享工具，你可以使用在线的 ShowDoc [http://www.showdoc.cc]( http://www.showdoc.cc/home/user/login)

- http://www.showdoc.cc 作为在线服务会长期维护，请放心托管你的文档数据。使用在线服务时请记住 showdoc 唯一官方网址 https://www.showdoc.cc

用 nextcloud 吧，偏向文件管理。
刚好总结出了一个脚本，给你看下 http://blog.star7th.com/2018/11/2329.html

我用我自己写的，你可以试试 https://www.showdoc.cc/

当一个村庄都是平房的时候，如果开始盖起几十座的大厦，就很容易被人拍手称赞这是颠覆性发展。
当大厦已经开始普遍的时候，它已经成为了一个城市。城市推到重来的成本，明显比颠覆村庄的成本高多了。所以进入现代化后，更多是完善已有的东西，而不是总是把已有的东西颠覆重来。
所以，我觉得你对科技发展的定义是狭隘的，并不是只有新型事物颠覆了旧事物才叫发展。能通过科技的手段让生活变得更好，这就是发展。
你没有发展这十年来，移动支付对现实生活的改变吗？大城市基本都普及了手机支付。而从手机支付出发，线下消费如外卖 /共享单车也应声而起，并且接下来还将有大量的线下消费场景可以挖掘。
现在云计算 /大数据技术都在蓬勃发展，大大地改变了很多企业的运维方式，节省了很多运作成本，提高了效率。十年前，还没有多少企业敢大量使用公有云（至少国内是），或者利用开源技术搭建私有大数据云？而现在，如果有经济投入的必要性，基本没有企业抗拒云了（公有云或者私有云）。
我觉得，互联网的往后十年或者二十年的发展更多发生在企业上，用互联网技术改善传统行业，提高社会整体效率。这个过程中，不仅经济变好，也可能会爆发出很多创新点。未来有什么可能性，很难预知的。
而且，把时间范围拉大，这几十年来，技术一直都在发展，偶尔快偶尔慢，从来没停滞

很早前写的一个简单开源队列服务 https://github.com/star7th/htq

合理使用缓存能让单机服务器的性能提高数倍，尤其是 web 服务，基本瓶颈都在数据库查询上。把结果缓存到内存中，跟每次从磁盘读，差别很大的。

@zqguo 发现好像是差了一个像素。下个版本修正

@chengfeng1992 你说的这些确实是问题。
第 1 和第 2 点是同一个问题。因为 showdoc 曾经很长一段存在一个不好发现的 bug ——当一个目录的父目录设置为自己或者一个二级目录转为三级目录的时候，会导致整个目录下的文档消失。数据库是有数据，但不会展示出来。现在已经修正问题了。
第 3 点，因为曾经调整过几次转义和安全的问题，所以调整过程中可能有用户的文档数据被转义了。确实是 showdoc 问题。现在已经兼顾好了安全和转义的问题。
第 4 点，这个问题现在还存在着，因为我觉得太长文档的情况不会多。看来我应该预先判断文档长度，来提示用户要不要关闭 html 预览。长文档特别卡的情况是因为 html 预览渲染太消耗浏览器性能。
第 5 点，showdoc 对 markdown 的转换有个改动，已经大部分支持标准语法。有没有解决极端情况下的语法，则尚不清除。
第 6 点，默认情况下，按照序号排序。当序号都相同的时候，将按 id 排序。不知道你说的问题还存在不存在。

@zqguo 原理是根据程序注释来生成。详细看文档吧

@heybuddy 让其可选的话，是一个选择。后面考虑吧

@zzf2017 正常情况它会暂停的。你这样情况可能出现了异常。建议 右击菜单，选择“ GIT BASH Here"，在弹出的命令行窗口手动执行 sh showdoc_api.sh

@heybuddy 那你们介意频繁被通知的情况吗

@heybuddy 关于更新提醒，其实我有考虑过。但是好像如果每一次修改都推送一次提醒（无论是用钉钉还是邮件提醒等方式），都太频繁了。比如说，我只是修改几个字，预览下，然后又再修改。所有我也不知道做更新提醒是不是一件好事

@dobelee 跟两年前差别还是挺多的。你有时间可以把 bug 都列出来，看是否解决了

@anxious
1，showdoc 生成的文档美观很多 ，这是个 api 文档例子 https://www.showdoc.cc/web/#/demo?page_id=9
2，showdoc 不限定特定语言或者框架，可以支持多种语言。
3，showdoc 不仅可以自动生成文档，也支持到网页端编辑，团队协作