通過 GitBook 開源框架和 GitHub 私有化部署 Wiki 文件
阿新 • • 發佈:2019-02-09
專案介紹
思路:通過將 Wiki 文件內容的倉庫託管在 GitHub 之上,並且將 GitBook 框架的程式碼放在倉庫中 ,然後找一臺有 Node.js 環境的伺服器,通過簡單的幾行命令就能部署成功,十分鐘內能搞定。從而具備多人協作、版本控制、Markdown 寫作、程式碼高亮、實時更新的特性。
一、效果展示
1、Material Design 中文版(有側邊欄選單)
2、GitBook Help Center(無側邊欄選單)
二、功能特性
1、頁面美觀
主要體現在兩個方面:其一,頁面的外觀,請回頭看看上面的效果圖。其二,連結的格式,如下:
2、多人協作 & 版本控制
文件內容託管於 GitHub 之上,GitHub 本身就具備 多人協作
和 版本控制
的功能。當然所有的
Git 託管平臺都可以,比如說國外的 GitLab、Bitbucket,或者國內的 git.oschina.net、coding.net 都行。
如果希望倉庫私有,國外產品推薦 Bitbucket,因為他私有倉庫免費,而 GitHub 私有倉庫收費。國內的好像私有倉庫都免費,在安全性和穩定性方面可能不如 Bitbucket。
3、Markdown 寫作
文件內容託管於 GitHub 之上,GitHub 本身就具備 Markdown 寫作
的功能。
4、程式碼高亮
通過 GitBook 的外掛能很容易支援程式碼高亮(這就是站在巨人的肩膀上的好處)。
5、實時更新
通過給 GitHub 倉庫配置 webhook
進行 push 時的訊息推送,能觸發伺服器實時更新(伺服器上需要些程式碼)。
6、一鍵部署
只需要簡單的幾行命令就部署完畢。
三、所需資源
唯一的一個條件就是,一臺支援 Node.js 的伺服器(公網和內網伺服器都行)。
四、交流學習
歡迎加群詳聊
如果掃碼加群不成功,請新增四勾的個人微信,再由四勾邀請入群,加好友時請填寫驗證資訊「字條網加群」
新增 四勾 4J
個人微信 vincent4j
。