使用 simpler-paper 快速搭建文檔系統指南

第一次讓我寫文檔時，我是拒絕的。因為寫出來的文檔壓根沒有人會認真看，我悄悄的在文檔裡面加上 Google Analytics 之後發現並沒有人打開超過 3 頁，他們只是看幾頁就不耐煩地對我流露出瞭然於胸的表情，像是在告訴我 『小子，你的文檔我看過了，like shit ！』

我把這些經歷歸結於自己的文檔做的不夠好，而且我明白了好的文檔本身就不是給人看的，它的潛台詞是告訴你，嘿，我的這個項目很叼，你知道嗎？懷著這樣的想法的我做了一個工具，讓自己能在 5分鐘之內生產出讓別人閉嘴的文檔，今天我也要告訴你該怎麼用它。

先讓我們看看效果：

如果你覺得它不好看，那要趕緊關掉頁面，因為這個文檔系統還有兩個更丑的主題。當然我也是求上進的，我請了一位設計師在為它設計新的樣式。（設計師不鴿我的前提下）

Simpler Paper 是基於 NodeJS 運行的，如果你的電腦里沒有 NodeJS，那麼我建議你去下載一個試試。

1. 安裝與創建。

# 下載npm i -g simpler-paper # 創建 paper init

simpler-paper 會被安裝在全局，在 paper init 時會在你的當前文件夾下創建一個文檔文件夾，並且為你創建一個配置文件 paper.config.json。 然後你就可以在這個文件夾下寫點 markdown 文件 (xxx.md) 作為文檔的內容啦。

那如果你已經有了文檔文件夾怎麼辦？按照命令的指引輸入你文件夾的名字即可。

2. 編譯一個。

paper build

build 比較機智的地方在於它總是能自動找到你含有配置文件的地方進行編譯，然後輸出在指定位置。任何時候你完成編輯 markdown 後，來一句 paper build 總是感覺不錯的！

3. 預覽一個。

paper server

在部署前你可以在本地看看文檔編譯後什麼樣，當然它也會自己去找編譯輸出的文件夾。

4. 部署到 github 。

paper deploy

這就完了？是的。

deploy 後 simpler-paper 會做幾件小事，把你的文件部署到 github 的 gh-pages 分支上，你只需要去項目里打開設置就能看到效果。(當然了，你的當前文件夾得是個 git 項目是吧)

好了現在看起來不錯，你還可以在配置文件中指定主題、指示器、文檔目錄方式等等，這些以後可以再去看文檔，當然也需你看完文檔發現其中並沒有多層目錄、文件排列先後順序、代碼高亮的配置，這是因為我把它做成了約定。

• 多層目錄的菜單結構是按文檔的目錄層次決定的，這是不用配置的。
• 改變文件順序，比如使某個文件夾或 xxx.md 排列在更前面，只需要在文件或文件夾的名稱上加一個數字前綴即可，這些數字代表著權重，就像 CSS 的 z-index 一樣寫就行：100000_install.md 。
• 增加代碼高亮更簡單，去 highlight 項目生成個 highlight.css 與 highlight.js 扔在文檔目錄里就行， simpler-paper 會自己去找的，如果有這些文件就會自動載入。

我在項目里也寫了更完善的文檔，你可以去 github 看看。

先吹一下，我準備把它做成 50+ 主題的文檔系統，如果你擅長 CSS 也可以去項目里貢獻幾個，不會也沒有關係，畢竟也可以在 Issue 里拍拍腦袋，搞點需求出來嘛。

（寫不下去了，感覺這篇文章也太水了……）