學習足跡

2015年3月3日 星期二

在 gitbook 使用 GA(Google Analytics)跟 Disqus 留言板

需要環境
node.js
npm

安裝 Gitbook 本地端服務

安裝 gitbook 到全域套件中

$ npm install gitbook -g 
到你自己的 Gitbook 書籍中,打入下列指令,你就可以在 http://localhost:5566 看到這本書籍在 Gitbook 上面的樣子了
$ gitbook serve -p 5566


安裝 GA(Google Analytics)

我們使用 Gitbook 寫了書之後,Gitbook 雖然有提供簡易的流量分析,但如果我們想更知道看我們書這些使用者的一些詳細資料,我們可能會想要使用我們常用來分析流量的GA(Google Analytics)來分析,以下會介紹要怎麼把 GA 安裝在 Gitbook 上。


我們會使用 gitbook-plugin-ga 這個 NPM 的套件來擴充 Gitbook 的功能。

安裝 gitbook-plugin-ga 到全域套件中

$ npm install -g gitbook-plugin-ga 
在 Gitbook 目錄下設定 book.json 檔案(若沒有該檔案則自行建立),自行將 token 設為你自己的 GA token。
{
    "plugins": ["ga"],
    "pluginsConfig": {
        "ga": {
            "token": "UA-XXXX-Y"
        }
    }
}
重新執行 gitbook 服務,就可以在 http://localhost:5566 看看你的頁面中原始碼有沒有被加入 GA token
$ gitbook serve -p 5566
之後將「book.json」加入版本控制,然後再推送到 Gitbook 即可

安裝 Disqus 留言板

我們在 Gitbook 寫了書之後,我們想要跟我們的讀者進行互動,或者是書籍有什麼錯誤需要讀者提醒修正的地方,沒有一個管道可以讓讀者表達,我們可以安裝 Disqus 留言板到 Gitbook 來完成這樣的目的。

安裝 gitbook-plugin-disqus 到全域套件中

$ npm install -g gitbook-plugin-disqus
在 Gitbook 目錄下設定 book.json 檔案(若沒有該檔案則自行建立),自行將 shortName 設為你自己在 disqus 中網址的前綴詞(e.g.  kejyun-disqus-short-name.disqus.com)

{
    "plugins": ["disqus"],
    "pluginsConfig": {
        "disqus": {
            "shortName": "kejyun-disqus-short-name"
        }
    }
}

重新執行 gitbook 服務,就可以在 http://localhost:5566 看看你的頁面有沒有被加入 Disqus 留言板了
$ gitbook serve -p 5566
之後將「book.json」加入版本控制,然後再推送到 Gitbook 即可

提醒

安裝 NPM 套件是為了能夠在本地端看到套件執行的樣子,如果沒有要在本地端預覽,請直接把 book.json 加入設定好後,再推送到 Gitbook 即可,不需要安裝任何的套件。

參考資料

沒有留言:

張貼留言