開源專案名稱:docsify
開源專案負責人:@Cinwell、@沈唁
開源專案簡介:一個神奇的文件網站生成器
開源專案型別:個人開源專案
專案建立時間:2016 年
GitHub 資料:15.4k Star,2.7k Fork
GitHub 地址:https://github.com/docsifyjs/docsify
專案介紹
docsify 是一個神奇的文件網站生成器。可以快速幫你生成文件網站。不同於 GitBook、Hexo 的地方是它不會生成靜態的 .html 檔案,所有轉換工作都是在執行時。如果你想要開始使用它,只需要建立一個 index.html 就可以開始編寫文件並直接部署在 GitHub Pages 等地方。
無論開源專案還是內部專案,在開發專案時,想要使用 Markdown 構建文件,將文件統一管理,docsify 是不錯的選擇。無需構建和編譯,寫完 Markdown 就可以直接釋出。
特性
- 無需構建,寫完文件直接釋出
- 容易使用並且輕量 (壓縮後 ~21kB)
- 智慧的全文搜尋
- 提供多套主題
- 豐富的 API
- 支援 Emoji
- 相容 IE11
- 支援服務端渲染 SSR (示例)
思否推薦
技術人員在完成專案或者對接專案時需要去寫一些專案手冊,記錄開發中的流程、使用方法以及一些注意事項。部署完畢後分享給與專案相關的同事,以提高協作效率。雖然說線上文件能完成這項工作,但是線上文件對於程式碼、公式的展示遠遠不如純 Markdown 的編輯,這時候可以選擇 docsify 這類的工具來進行文件部署。以下幾點是 docsify 做的比較好的:
- Markdown 書寫,託管在 Github 上,可以自己輕鬆自定義域名
- Markdown 中的標題自動生成目錄
- 整體頁面的配色和佈局舒適易讀
如果你有自己部署文件分享的需求,不如試試 docsify 吧。
該專案已入選「SFOSSP - 思否開源專案支援計劃」,我們希望藉助社群的資源對開源專案進行相關的宣傳推廣,並作為一個長期專案助力開源事業的發展,與廣大開發者共建開源新生態。
有意向的開源專案負責人或團隊成員,可通過郵箱(pr@segmentfault.com)提供相應的資訊(開源專案地址、專案介紹、團隊介紹、聯絡方式等),以便提升交流的效率。