用Sphinx搭建博客時(shí)，如何自定義插件？-創(chuàng)新互聯(lián)

之前有不少同學(xué)看過我的個(gè)人博客（http://python-online.cn），也根據(jù)我寫的教程完成了自己個(gè)人站點(diǎn)的搭建。

成都創(chuàng)新互聯(lián)歡迎咨詢：18980820575，為您提供成都網(wǎng)站建設(shè)網(wǎng)頁設(shè)計(jì)及定制高端網(wǎng)站建設(shè)服務(wù)，成都創(chuàng)新互聯(lián)網(wǎng)頁制作領(lǐng)域10多年，包括成都混凝土攪拌站等多個(gè)行業(yè)擁有豐富的網(wǎng)站維護(hù)經(jīng)驗(yàn)，選擇成都創(chuàng)新互聯(lián)，為企業(yè)錦上添花。

點(diǎn)此：使用 Python 30分鐘 教你快速搭建一個(gè)博客

為防有的同學(xué)不清楚 Sphinx ，這里還是做下簡單的介紹。

它是一個(gè)能夠把一組 reStructuredText 或者 Markdown 格式的文件轉(zhuǎn)換成各種輸出格式，而且自動(dòng)地生成交叉引用，生成目錄等的一個(gè)文檔編排工具。

不得不說，它的排版功能強(qiáng)大、非常清晰，顔值非常高。

但是使用這個(gè)方法搭建的博客，一直有一個(gè)痛點(diǎn)，就是無法自定義頁面，自由度非常的低（和 WordPress 真的沒法比）。

這就導(dǎo)致我一直不知道到底有沒有人訪問我的網(wǎng)站？

他們都是從哪來訪問的，Google 還是 百度？

每篇文章都有多少人訪問，哪篇文章最受歡迎？

我一直在我的博客上×××底因×××少呢？

因此我一直希望能找到一個(gè)能夠收集網(wǎng)站訪問數(shù)據(jù)、并且能將博客上的訪×××

終于在昨天，我找到了，并花了兩天的時(shí)間成功上線。

方法就是引入兩個(gè) JavaSript 插件實(shí)現(xiàn)（這個(gè)在早期的 Sphinx 版本中是不支持的）。

第一個(gè)插件：導(dǎo)流工具

作用：這個(gè)主要用來將自己博客上流量引×××是思路是：

游客無法閱讀博客的全部內(nèi)容，因?yàn)闀?huì)有一半的內(nèi)容會(huì)被隱藏。就像這樣。

如想要閱讀全文，可以點(diǎn)擊全文進(jìn)行解鎖：用微信掃描二維×××ore` ，將獲取到的驗(yàn)證碼填入如下文本框提交即可永久解鎖本博客的所有干貨文章。

思路有了，那么如何實(shí)現(xiàn)呢？

以上功能其實(shí)已經(jīng)有人已經(jīng)做出來并可以提供免費(fèi)使用。

你可以在 https://openwrite.cn/ 注冊一個(gè)帳號，然后在里面你可以看到一個(gè)導(dǎo)流工具，×××信息后，就初始化成功，獲得一串js代碼。

接下來，你要做的就是將這串js接入你的博客頁面中。

由于我去年搭建這個(gè)博客時(shí)使用的 Sphinx 的版本是 1.7 ，這個(gè)版本是不支持自定義css/js 文件的。

因此，你要使用引入這段js代碼，需要將你的 Sphinx 升級到 1.8+，我使用的是最新版本的 2.1 ，這個(gè)版本只支持 Python 3.5+。

因此在使用之前，我得先將環(huán)境的切換至 Python 3.5+。

virtualenv -p /usr/bin/python3.6 myblog

然后安裝 Sphinx 及相關(guān)包

pip install Sphinx sphinx-rtd-theme -i https://pypi.douban.com/simple

問題一

雖然現(xiàn)在我們的 Sphinx 已經(jīng)支持自定義js了（方法是將一個(gè)js文件以引用的方式放在 header 標(biāo)簽里）

但是 OpenWrite 要實(shí)現(xiàn) 閱讀全文 的效果，這個(gè)readmore.js必須放在 HTML 的尾部，意思是要等頁面加載完成后才能起作用。

這下就尷尬了。Sphinx 會(huì)將 readmore.js 放在 HTML 頂部，而要實(shí)現(xiàn) 閱讀全文 的效果，readmore.js 需要放在底部。由于框架是固定的，我們無法對其進(jìn)行定制修改。那還有什么方法可以補(bǔ)救呢？

我的方案是：在 readmore.js 中加入邏輯，當(dāng)頁面加載完成后再運(yùn)行。

問題二

若想 readmore.js 起作用，前提是你的文章的正文div中需要有一個(gè)id=‘container’屬性， 而這個(gè) Sphinx 是不會(huì)生成的。

這樣的話，這個(gè)動(dòng)態(tài)添加 id 屬性的工作也只能交由 readmore.js 來做了。

問題三

由 Sphinx 生成的的所有頁面都會(huì)加引入這個(gè) readmore.js 插件，這就導(dǎo)致所有的頁面（包括首頁，索引頁）都會(huì)有 閱讀全文 的限制。這明顯是不合理的。

為了解決這個(gè)問題，我想的是在 readmore.js 中，根據(jù) url 進(jìn)行判斷，只有文章頁面才有限制，而其他的頁面則不受限制。

總結(jié)一下，這個(gè) readmore.js 會(huì)做三件事：

1. 判斷頁面是否加載完成，加載完成后才執(zhí)行；
2. 給 class 為 rst-content 的 div 加一個(gè) id 屬性：container；
3. 根據(jù)網(wǎng)頁地址判斷是否文章頁面，是則執(zhí)行，否則不執(zhí)行；

如果你不想自己寫，可×××流”，直接用我寫好的js文件。

獲取到的js文件需要放在固定的路徑下： source/_static/js/ （如果沒有此路徑就手動(dòng)創(chuàng)建），然后修改 conf.py

html_static_path = ['_static']

html_js_files = [
    'js/readmore.js',
]

按理說，這樣就已經(jīng)大功告成了。

但是別忘了，我們是用 readthedocs 生成我們的博客頁面的。

為此，我們同樣也要在 readthedocs 進(jìn)行相關(guān)的配置。

1. 改 CPython 2.x 為 CPython 3.x
2. 指定我們的本地最新生成的 requirements.txt

（注：使用 pip freeze >requirements.txt 生成）

同時(shí)你如果之前是看過我寫的教程，使用過我的中文檢索插件，那你要注意了。

此前這個(gè)插件是基于 Python 2.x 寫的，現(xiàn)在我們切換成 Sphinx 項(xiàng)目切換成 Python 3.x ，所以這里的代碼也要對應(yīng)修改。

改動(dòng)也不大，只要把 exts/smallseg.py 這個(gè)文件里的 decode 相關(guān)的代碼全部去掉即可。

一切按照上面的步驟全部設(shè)置完成后，提交Github后，再次從 readthedocs 構(gòu)建就可以看到效果了。

對于這個(gè)功能，我?guī)c(diǎn)要說明：

1. 對于經(jīng)?？次也┛偷耐瑢W(xué)，如果你已×××驗(yàn)證一下。
2. 如果你換電腦、瀏覽器，會(huì)需要你重新驗(yàn)證，這點(diǎn)希望大家包容。

第二個(gè)插件：百度統(tǒng)計(jì)

作用：用于收集個(gè)人網(wǎng)站的訪問數(shù)據(jù)。

有了上面的經(jīng)驗(yàn)，現(xiàn)在我們知道如何在頁面中插件自定義 js 代碼。

那我就想有沒有那種可以通過引入 js 插件來收集網(wǎng)站的訪問數(shù)據(jù)呢？

這種工具應(yīng)該不少，而我使用的是百度家的產(chǎn)品 - 百度統(tǒng)計(jì) 。

它可以幫我們收集網(wǎng)站訪問數(shù)據(jù)，提供流量趨勢、來源分析、轉(zhuǎn)化跟蹤、頁面熱力圖、訪問流等多種統(tǒng)計(jì)分析服務(wù)。

那怎么使用呢？

首先使用你的百度帳號登陸 百度統(tǒng)計(jì)。

然后在網(wǎng)站列表新增一個(gè)你的網(wǎng)站，我的信息如下：

填寫完成，就可以獲取一段屬于你的網(wǎng)站的專屬 js 代碼（下面第一步）。

第二步內(nèi)容，是教你如何安裝這段 js 代碼。

將這段代碼內(nèi)容寫入一個(gè)單獨(dú)的 js 文件：baidu#js

var _hmt = _hmt || [];
(function() {
  var hm = document.createElement("script");
  hm.src = "https://#/hm.js?xxxxxxxx";
  var s = document.getElementsByTagName("script")[0]; 
  s.parentNode.insertBefore(hm, s);
})();

并修改 conf.py 后，提交至你的 Github。

html_js_files = [
    'js/readmore.js',
    'js/baidu#js'
]

一切完成后，就可以去 readthedocs 重建構(gòu)建。

構(gòu)建完成后，去執(zhí)行第三步，代碼安裝檢查。像我下面這樣，就是安裝完成了。

這個(gè)插件安裝完成后，如果你的網(wǎng)站有流量，可以過個(gè)一個(gè)小時(shí)，點(diǎn)擊一下查看報(bào)告查看你網(wǎng)站的詳細(xì)訪問數(shù)據(jù)。

數(shù)據(jù)真的非常全面，你可以知道，訪客都是從哪里訪問（直接訪問，Google等），每篇文章的點(diǎn)擊量（你就知道哪篇是爆款？），每天有多少老訪問客，多少新訪客等等，更多維度的數(shù)據(jù)你可以自己去體驗(yàn)一下。

另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無理由+7*72小時(shí)售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場景需求。

文章標(biāo)題：用Sphinx搭建博客時(shí)，如何自定義插件？-創(chuàng)新互聯(lián)
標(biāo)題鏈接：http://muchs.cn/article20/egdjo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供定制網(wǎng)站、建站公司、網(wǎng)站營銷、品牌網(wǎng)站設(shè)計(jì)、網(wǎng)站導(dǎo)航、外貿(mào)網(wǎng)站建設(shè)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)