一个好用的文档管理服务器-showdoc

一、服务器安装

  1. 先看使用效果。
  2. 文档记录的作用对我们技术人来说是十分重要的。好的文档记录能让我们面对之前出现过的类似问题时候，事半功倍。不至于捡芝麻丢西瓜，一直在同一个地方打转。
  3. showdoc是一个可以本地搭建的文档管理服务器。对技术团队十分有用。
#下载脚本并赋予权限
   wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc;

  #默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
  ./showdoc
  1. 自己测试使用 ubuntu20.04 和 ubuntu16.04 都是可以使用上述命令自动安装好的。很方便。
  2. 因为是本地搭建的服务器，我们可以做很多其它的操作。
  1. 比如，自动分析文件中的注释，自动生成文档，然后自动上传到服务器。
  2. 上传的方式也可以优化，我自己写了一个上传文档的小程序。只支持本地搭建的服务器。
  3. 可以批量上传，如果有一堆文档的话，可以自己写个小程序批量上传。
  1. 搭建成功后，直接访问 http://ip:4999 就可以访问了。默认用户名密码是showdoc/123456。
  2. 本地显示如图，可以说非常清爽：
  3. showdoc 完全开源，也是本地搭建的，所以是安全的。

二、本地搭建服务器的相关API和使用

  1. 因为是本地搭建的服务器。我们可以通过抓包，查看每一步操作是如何和服务器交互的。

这是我自己测试出来的一些交互接口。

我自己使用这些接口写了一个把文档上传showdoc服务器的小程序。源码点击传送门，有兴趣的可以看看，用python写的。

我已经把程序编成了exe格式。放在这里;可以直接下载按照文档使用。

  1. 使用方法记录在文档中了。配置好之后，右键选中可以上传。并且可以自动上传markdown格式中的图片到服务器。为了方便，以后可能面临的服务器IP变动，建议使用域名而不是写死的IP地址为服务器地址。
  2. 小程序的使用效果，可以看到连同图片是一起倒入到服务器了:

show element无内容 show document_服务器

三、我的文档管理方法

  1. 我现在使用typora 编辑markdown，这也是一个十分好用的工具。可能需要做
  2. 编辑的内容基本放在坚果云中。用于家里和公司同步。感觉坚果云目前也是比较好用的。
  3. 重要的给团队写的文档，可以使用我的文档上传小工具，方便的上传编写好的文档。
  4. 坚果云和typora的合作关系，可以参考这里。
  5. 目前我的文档管理方案示意图。存放到服务器之后，通过web就可以访问文档，可以搜索内容，对不同文档设定权限。
  6. 如果觉得手动把坚果云的文档上传到服务器麻烦，可以自己写个小程序，自动把某些指定文件夹下的文档上传到服务器。 将家里和公司的文档服务器使用坚果云联通起来。
  7. 虽然使用 everything 也可以查找文件内容，但是使用体验没有这个好。