docsify|一個神奇的文件生成工具

我們在開發專案時，有時需要一份精緻的開發文件，那麼使用docsify是不錯的選擇，docsify是一個文件生成工具，它直接載入 Markdown 檔案並動態渲染，同時還可以生成封面頁。所以我們只需要寫完 Markdown 文件，就可以看到文件頁面了。

特性

無需構建無需編譯，寫完markdown文件直接釋出

容易使用並且輕量 （~18kB gzipped）

智慧的全文搜尋

提供多套主題

豐富的 API

支援 Emoji

相容 IE10+

支援 SSR （example）

快速上手

我們直接建立一個index。html檔案。

新建README。md檔案，作為主頁面，編輯：

如果你係統安裝了web伺服器的話，直接執行web服務，比如我使用PHP，命令列直接啟動web服務。

然後直接在瀏覽器開啟localhost：3000，就可以看到基本的網頁框架了。接下來我們就需要寫文件了。

當然你也可以直接把構建好的文件放到你的web伺服器上，比如nginx、apache或者IIS上預覽。

我們也可以安裝官方提供的docsify-cli工具，可以方便建立及本地預覽文件網站。

docsify提供 LiveReload 功能，可以讓實時的預覽，預設訪問localhost：3000。

多頁面

README。md作為主頁面，如果需要建立多個頁面，或者需要多級路由的網站，在 docsify 裡也能很容易的實現。直接在文件目錄下建立對應的 *。md 檔案，例如建立一個guide。md那麼對應的路由就是/guide。

假設你的目錄結構如下：

那麼對應的訪問頁面將是：

定製側邊欄

預設情況下，側邊欄會根據當前文件的標題生成目錄。也可以設定文件連結，透過 Markdown 檔案生成，效果如當前的文件的側邊欄。

首先配置loadSidebar選項。

接著建立 _sidebar。md 檔案，內容如下

然後只要在對應的install。md和guide。md兩個檔案中寫內容就OK了。當然這兩個文件都是Markdown格式的，需要按照markcodown語法來編輯。markcodown語法很簡單，百度一把，十分鐘入門，半小時精通。

主題

目前提供三套主題可供選擇，模仿 Vue 和 buble 官網訂製的主題樣式。還有 @liril-net 貢獻的黑色風格的主題。直接修改index。html中的css連結即可。

全文搜尋

docsify支援全文搜尋，docsify會根據當前頁面上的超連結獲取文件內容，在 localStorage 內建立文件索引。預設過期時間為一天，當然我們可以自己指定需要快取的檔案列表或者配置過期時間。

執行後，我們在頁面的左上角會有一個搜尋框，支援全文搜尋的。