在安裝Apidoc中我踩的坑

Apidoc github 地址

首先按照網上的教程，安裝apidoc的步驟只有這麼幾步:

brew install node  // (若是沒有安裝過node的話)
sudo npm install apidoc -g // 而後安裝全局的apidoc
複製代碼

但是我安裝完後，使用apidoc的指令，沒用啊。報的錯誤都是：

zsh not found apidoc command
複製代碼

就是我識別不出來啊，你安裝了也沒安裝。並且奇怪的是，你們好像都是一遍就安裝經過的。因此呢，這裏我記錄一下，我是怎麼安裝的呢。

首先進入到根目錄，而後執行:

npm install apidoc
複製代碼

這個時候，根目錄下就會有一個node初始化完的全部文件，其實這樣很差啊，可是，emmmm。而後你會看到有node_modules的文件夾。而後cd到apidoc，將bin目錄下的apidoc指令，軟鏈接到/usr/local/bin下就能夠了！

最後執行:

apidoc -i {source category} -o apidoc/
複製代碼

前提是你已經寫了apidoc.json文件了，裏面是一些生成文檔的配置信息。

至於怎麼寫這個api doc, 那就自行google。