思否開源項目推介丨docsify：一個神奇的文檔網站生成器

開源項目名稱：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 作的比較好的：

1. Markdown 書寫，託管在 Github 上，能夠本身輕鬆自定義域名
2. Markdown 中的標題自動生成目錄
3. 總體頁面的配色和佈局溫馨易讀

若是你有本身部署文檔分享的需求，不如試試 docsify 吧。

該項目已入選 「SFOSSP - 思否開源項目支持計劃」，咱們但願藉助社區的資源對開源項目進行相關的宣傳推廣，並做爲一個長期項目助力開源事業的發展，與廣大開發者共建開源新生態。
有意向的開源項目負責人或團隊成員，可經過郵箱（pr@segmentfault.com）提供相應的信息（開源項目地址、項目介紹、團隊介紹、聯繫方式等），以便提高交流的效率。