推薦一個好用的文檔管理伺服器-showdoc

一個好用的文檔管理伺服器-showdoc

一、伺服器安裝

1. 先看使用效果。

   

2. 文檔記錄的作用對我們技術人來說是十分重要的。好的文檔記錄能讓我們面對之前出現過的類似問題時候，事半功倍。不至于撿芝麻丢西瓜，一直在同一個地方打轉。
3. showdoc是一個可以本地搭建的文檔管理伺服器。對技術團隊十分有用。

   #下載下傳腳本并賦予權限
      wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc;
   
     #預設安裝中文版。如果想安裝英文版，請加上en參數，如 ./showdoc en
     ./showdoc
              

4. 自己測試使用 ubuntu20.04 和 ubuntu16.04 都是可以使用上述指令自動安裝好的。很友善。
5. 因為是本地搭建的伺服器，我們可以做很多其它的操作。
   1. 比如，自動分析檔案中的注釋，自動生成文檔，然後自動上傳到伺服器。
   2. 上傳的方式也可以優化，我自己寫了一個上傳文檔的小程式。隻支援本地搭建的伺服器。
   3. 可以批量上傳，如果有一堆文檔的話，可以自己寫個小程式批量上傳。
6. 搭建成功後，直接通路 http://ip:4999 就可以通路了。預設使用者名密碼是showdoc/123456。
7. 本地顯示如圖，可以說非常清爽：

   

8. showdoc 完全開源，也是本地搭建的，是以是安全的。

二、本地搭建伺服器的相關API和使用

1. 因為是本地搭建的伺服器。我們可以通過抓包，檢視每一步操作是如何和伺服器互動的。

   

   這是我自己測試出來的一些互動接口。

   我自己使用這些接口寫了一個把文檔上傳showdoc伺服器的小程式。源碼點選傳送門，有興趣的可以看看，用python寫的。

   我已經把程式編成了exe格式。放在這裡;可以直接下載下傳按照文檔使用。

2. 使用方法記錄在文檔中了。配置好之後，右鍵選中可以上傳。并且可以自動上傳markdown格式中的圖檔到伺服器。為了友善，以後可能面臨的伺服器IP變動，建議使用域名而不是寫死的IP位址為伺服器位址。
3. 小程式的使用效果，可以看到連同圖檔是一起倒入到伺服器了:

三、我的檔案管理方法

1. 我現在使用typora 編輯markdown，這也是一個十分好用的工具。可能需要做
2. 編輯的内容基本放在堅果雲中。用于家裡和公司同步。感覺堅果雲目前也是比較好用的。
3. 重要的給團隊寫的文檔，可以使用我的檔案上傳小工具，友善的上傳編寫好的文檔。
4. 堅果雲和typora的合作關系，可以參考這裡。
5. 目前我的檔案管理方案示意圖。存放到伺服器之後，通過web就可以通路文檔，可以搜尋内容，對不同文檔設定權限。

   

6. 如果覺得手動把堅果雲的文檔上傳到伺服器麻煩，可以自己寫個小程式，自動把某些指定檔案夾下的文檔上傳到伺服器。 将家裡和公司的文檔伺服器使用堅果雲聯通起來。
7. 雖然使用 everything 也可以查找檔案内容，但是使用體驗沒有這個好。