docsify

在開發項目時,想要將md文檔統一管理,docsify是不錯的選擇。無需構建和編譯,寫完markdown就能夠直接發佈。html

快速上手

全局安裝docsify-cli工具npm

npm i docsify-cli -g

初始化項目瀏覽器

docsify init ./docs

初始文件
index.html 入口文件
README.md 會作爲主頁內容渲染
.nojekyll 用於阻止 GitHub Pages 會忽略掉下劃線開頭的文件markdown

啓動項目
docsify serve docs
而後直接用瀏覽器打開localhost:3000,就能夠看到基本的網頁框架了。就像醬紫。
圖片描述框架

特性
容易使用而且輕量 (~18kB gzipped)
智能的全文搜索
提供多套主題
豐富的 API
支持 Emoji
兼容 IE10+
支持 SSR (example)

若是以爲README.md主頁面太簡陋的話能夠本身寫。連接文檔改爲對應的url。工具

相關文章
相關標籤/搜索