在開發項目時,我們或許需要一份精致的開發文檔,那么使用docsify是不錯的選擇,docsify是一個文檔生成工具,它直接加載 Markdown 文件並動態渲染,同時還可以生成封面頁。所以我們只需要寫完 Markdown 文檔,就可以看到文檔頁面了。
特性
無需構建無需編譯,寫完markdown文檔直接發布
容易使用並且輕量 (~18kB gzipped)
智能的全文搜索
提供多套主題
豐富的 API
支持 Emoji
兼容 IE10+
支持 SSR (example)
快速上手
我們直接創建一個index.html文件。
<!DOCTYPE html> <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta charset="UTF-8"> <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css"> </head> <body> <div id="app"></div> <script> window.$docsify = { //... } </script> <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> </body> </html>
新建README.md文件,作為主頁面,編輯:
# Title ## balabala
如果你系統安裝了web服務器的話,直接運行web服務,比如我使用php,命令行直接啟動web服務。
php -S localhost:3000
然后直接在瀏覽器打開localhost:3000,就可以看到基本的網頁框架了。接下來我們就需要寫文檔了。
當然你也可以直接把構建好的文檔放到你的web服務器上,比如nginx、apache或者IIS上預覽。
我們也可以安裝官方提供的docsify-cli工具,可以方便創建及本地預覽文檔網站。
npm i docsify-cli -g
docsify init ./docs
docsify serve docs
docsify提供 LiveReload 功能,可以讓實時的預覽,默認訪問localhost:3000。
多頁面
README.md作為主頁面,如果需要創建多個頁面,或者需要多級路由的網站,在 docsify 里也能很容易的實現。直接在文檔目錄下創建對應的 *.md 文件,例如創建一個guide.md那么對應的路由就是/guide。
假設你的目錄結構如下:
-| docs/
-| README.md
-| guide.md
-| zh-cn/
-| README.md
-| guide.md
那么對應的訪問頁面將是:
docs/README.md => http://domain.com docs/guide.md => http://domain.com/guide docs/zh-cn/README.md => http://domain.com/zh-cn/ docs/zh-cn/guide.md => http://domain.com/zh-cn/guide
定制側邊欄
默認情況下,側邊欄會根據當前文檔的標題生成目錄。也可以設置文檔鏈接,通過 Markdown 文件生成,效果如當前的文檔的側邊欄。
首先配置loadSidebar選項。
<script> window.$docsify = { loadSidebar: true } </script> <script src="//unpkg.com/docsify"></script>
接着創建 _sidebar.md 文件,內容如下
- [安裝](install.md) - [介紹](guide.md)
然后只要在對應的install.md和guide.md兩個文件中寫內容就OK了。當然這兩個文檔都是Markdown格式的,需要按照markcodown語法來編輯。markcodown語法很簡單,百度一把,十分鍾入門,半小時精通。
資源搜索網站大全 https://www.renrenfan.com.cn 廣州VI設計公司https://www.houdianzi.com
主題
目前提供三套主題可供選擇,模仿 vue 和 buble 官網訂制的主題樣式。還有 @liril-net 貢獻的黑色風格的主題。直接修改index.html中的css鏈接即可。
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css"> <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/buble.css"> <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/dark.css"> <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/pure.css">
全文搜索
docsify支持全文搜索,docsify會根據當前頁面上的超鏈接獲取文檔內容,在 localStorage 內建立文檔索引。默認過期時間為一天,當然我們可以自己指定需要緩存的文件列表或者配置過期時間。
<script> window.$docsify = { // 完整配置參數 search: { maxAge: 86400000, // 過期時間,單位毫秒,默認一天 paths: 'auto', placeholder: '搜索', noData: '沒有記錄!' } } </script> <script src="//unpkg.com/docsify"></script> <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
運行后,我們在頁面的左上角會有一個搜索框,支持全文搜索的。