隨着工作和項目經驗的積累,有很多知識點需要整理,其中有關開發或者技術方面的,我想搭建一個 Wiki 系統,既可以方便自己查詢,也給有需要的人參考,工欲善其事必先利其器,所以這篇就來寫下 Wiki 系統的選擇。
待選
首先,我結合已知的第三方 Wiki 系統,以及網上搜索的比較火的開源項目,整理出以下的待選列表。
篩選
接下來從不同方面對上面的待選列表進行逐一篩選。
自定義程度
第三方 Wiki 系統,如「語雀」和「看雲」,我在使用過程中發現以下幾點不足:
- 數據存於第三方服務器,文件歸屬上感覺不是自己的。
- 自定義域名等功能是有限制或者收費。
- 頁面自定義程度不高。
基於以上問題,我選擇放棄第三方的 Wiki 系統,轉而使用開源項目搭建自己的 Wiki。
產品定位
「Notion」從去年開始在國內逐漸變得很火,雖然可以用來做 Wiki,但是比 Wiki 更全,更強大,但僅僅作為 Wiki 又顯得不夠簡潔,不太像一個 Wiki,這是我放棄 Notion 的一個原因。
可以看下少數派的這篇文章「想要玩轉 Notion?你需要這份快速上手指南」,就能理解我說的不簡潔的意思了,當然並不是說 Notion 不好,只是在我看來做 Wiki 可能過於「重」了。
訪問速度
「Notion」官網目前訪問速度還可以,但是之前一直都很慢,基於國內網絡的情況,說不准什么時候又會給屏蔽了,所以這是放棄 Notion 的另一個原因。
部署復雜度
既然要使用開源項目部署 Wiki,那「GitBook」和「VuePress」是一定要考慮的。
客觀來講,GitBook 和 VuePress 界面相對簡潔美觀,部署及頁面編寫並不復雜,具體部署可參考下方鏈接。
但是相較於「docsify」來說,簡直是小巫見大巫,docsify 作為 Wiki 系統應該是我見過最輕量級的,而且界面美觀,自定義程度很高。
找到「docsify」的時候,我覺得就是它了。
docsify
「docsify」有多輕量級呢?雖然官方提供了構建工具,但你完全可以不使用構建工具,直接使用一個 index.html
就可以開始 Wiki 的內容制作了,詳細內容可以查看「快速開始」。
當然,docsify 並不只是輕量,還包含以下特性(官方說法):
- 無需構建,寫完文檔直接發布
- 容易使用並且輕量 (壓縮后 ~21kB)
- 智能的全文搜索
- 提供多套主題
- 豐富的 API
- 支持 Emoji
- 兼容 IE11
- 支持服務端渲染 SSR
在我看來,docsify 的特點如下:
- 界面簡潔大方,把重點留給了「內容」,也是 Wiki 最重要的部分。
- 支持全文搜索,自定義側欄,讓查詢和導航變得更容易。
- 豐富的插件,讓各種自定義功能觸手可及。
- 使用 Markdown 編寫文檔,符合我平時寫文章的習慣。
- 天生的輕量級讓我感覺它就是 Wiki 的不二選擇。
要說唯一的不足之處,可能就是對 SEO 的支持不太好,這點看個人取舍吧,就我個人而言,主要還是用於記錄和查詢技術知識,所以 SEO 對我而言並不重要。
以上就是我選擇 Wiki 的全部內容了,綜合各方面因素,最后選擇了接近完美的極輕量級的「docsify」,下一篇就來寫一下 docsify 的搭建及各項設置。
歡迎訪問的個人博客:掘墓人的小鏟子