文档章节

用 Sphinx 搭建博客时,如何自定义插件?

王炳明
 王炳明
发布于 10/18 23:58
字数 2059
阅读 13
收藏 0

之前有不少同学看过我的个人博客(http://python-online.cn),也根据我写的教程完成了自己个人站点的搭建。

点此使用 Python 30分钟 教你快速搭建一个博客

为防有的同学不清楚 Sphinx ,这里还是做下简单的介绍。

它是一个能够把一组 reStructuredText 或者 Markdown 格式的文件转换成各种输出格式,而且自动地生成交叉引用,生成目录等的一个文档编排工具。

不得不说,它的排版功能强大、非常清晰,顔值非常高。

但是使用这个方法搭建的博客,一直有一个痛点,就是无法自定义页面,自由度非常的低(和 WordPress 真的没法比)。

这就导致我一直不知道到底有没有人访问我的网站?

他们都是从哪来访问的,Google 还是 百度?

每篇文章都有多少人访问,哪篇文章最受欢迎?

我一直在我的博客上贴上我的公众号二维码,可到底因此关注我的人有多少呢?

因此我一直希望能找到一个能够收集网站访问数据、并且能将博客上的访客引导到公众号上来的方法。

终于在昨天,我找到了,并花了两天的时间成功上线。

方法就是引入两个 JavaSript 插件实现(这个在早期的 Sphinx 版本中是不支持的)。

第一个插件:导流工具

作用:这个主要用来将自己博客上流量引到自己的公众号上。

具体是思路是:

游客无法阅读博客的全部内容,因为会有一半的内容会被隐藏。就像这样。

如想要阅读全文,可以点击全文进行解锁:用微信扫描二维码关注我的个人公众号,发送 more ,将获取到的验证码填入如下文本框提交即可永久解锁本博客的所有干货文章。

思路有了,那么如何实现呢?

以上功能其实已经有人已经做出来并可以提供免费使用。

你可以在 https://openwrite.cn/ 注册一个帐号,然后在里面你可以看到一个导流工具,填写你的公众号及引流的相关信息后,就初始化成功,获得一串js代码。

接下来,你要做的就是将这串js接入你的博客页面中。

由于我去年搭建这个博客时使用的 Sphinx 的版本是 1.7 ,这个版本是不支持自定义css/js 文件的。

因此,你要使用引入这段js代码,需要将你的 Sphinx 升级到 1.8+,我使用的是最新版本的 2.1 ,这个版本只支持 Python 3.5+。

因此在使用之前,我得先将环境的切换至 Python 3.5+。

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

然后安装 Sphinx 及相关包

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

问题一

虽然现在我们的 Sphinx 已经支持自定义js了(方法是将一个js文件以引用的方式放在 header 标签里)

但是 OpenWrite 要实现 阅读全文 的效果,这个readmore.js必须放在 HTML 的尾部,意思是要等页面加载完成后才能起作用。

这下就尴尬了。Sphinx 会将 readmore.js 放在 HTML 顶部,而要实现 阅读全文 的效果,readmore.js 需要放在底部。由于框架是固定的,我们无法对其进行定制修改。那还有什么方法可以补救呢?

我的方案是:在 readmore.js 中加入逻辑,当页面加载完成后再运行。

问题二

若想 readmore.js 起作用,前提是你的文章的正文div中需要有一个id=‘container’属性, 而这个 Sphinx 是不会生成的。

这样的话,这个动态添加 id 属性的工作也只能交由 readmore.js 来做了。

问题三

由 Sphinx 生成的的所有页面都会加引入这个 readmore.js 插件,这就导致所有的页面(包括首页,索引页)都会有 阅读全文 的限制。这明显是不合理的。

为了解决这个问题,我想的是在 readmore.js 中,根据 url 进行判断,只有文章页面才有限制,而其他的页面则不受限制。

总结一下,这个 readmore.js 会做三件事:

  1. 判断页面是否加载完成,加载完成后才执行;
  2. 给 class 为 rst-content 的 div 加一个 id 属性:container;
  3. 根据网页地址判断是否文章页面,是则执行,否则不执行;

如果你不想自己写,可以在我的公众号后台回复“导流”,直接用我写好的js文件。

获取到的js文件需要放在固定的路径下: source/_static/js/ (如果没有此路径就手动创建),然后修改 conf.py

html_static_path = ['_static']

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

按理说,这样就已经大功告成了。

但是别忘了,我们是用 readthedocs 生成我们的博客页面的。

为此,我们同样也要在 readthedocs 进行相关的配置。

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

:使用 pip freeze >requirements.txt 生成)

同时你如果之前是看过我写的教程,使用过我的中文检索插件,那你要注意了。

此前这个插件是基于 Python 2.x 写的,现在我们切换成 Sphinx 项目切换成 Python 3.x ,所以这里的代码也要对应修改。

改动也不大,只要把 exts/smallseg.py 这个文件里的 decode 相关的代码全部去掉即可。

一切按照上面的步骤全部设置完成后,提交Github后,再次从 readthedocs 构建就可以看到效果了。

对于这个功能,我几点要说明

  1. 对于经常看我博客的同学,如果你已经关注我的公众号,仍然需要你验证一下。
  2. 如果你换电脑、浏览器,会需要你重新验证,这点希望大家包容。

第二个插件:百度统计

作用:用于收集个人网站的访问数据。

有了上面的经验,现在我们知道如何在页面中插件自定义 js 代码。

那我就想有没有那种可以通过引入 js 插件来收集网站的访问数据呢?

这种工具应该不少,而我使用的是百度家的产品 - 百度统计

它可以帮我们收集网站访问数据,提供流量趋势、来源分析、转化跟踪、页面热力图、访问流等多种统计分析服务。

那怎么使用呢?

首先使用你的百度帐号登陆 百度统计

然后在网站列表新增一个你的网站,我的信息如下:

填写完成,就可以获取一段属于你的网站的专属 js 代码(下面第一步)。

第二步内容,是教你如何安装这段 js 代码。

将这段代码内容写入一个单独的 js 文件:baidutongji.js

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

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

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

一切完成后,就可以去 readthedocs 重建构建。

构建完成后,去执行第三步,代码安装检查。像我下面这样,就是安装完成了。

这个插件安装完成后,如果你的网站有流量,可以过个一个小时,点击一下查看报告查看你网站的详细访问数据。

数据真的非常全面,你可以知道,访客都是从哪里访问(直接访问,Google等),每篇文章的点击量(你就知道哪篇是爆款?),每天有多少老访问客,多少新访客等等,更多维度的数据你可以自己去体验一下。

关注公众号,获取最新干货!

© 著作权归作者所有

王炳明
粉丝 0
博文 4
码字总数 9661
作品 0
厦门
私信 提问
VScode+Sphinx+ReadTheDocs 从环境搭建到放弃

概述 此篇博客用来记录在windows10中配置环境的过程,注意是Windows下 ,我没有在Linux下面尝试过配置。一下参考了各路教程加上自己亲测,应该是没有问题的。 ……..被掏空(◎_◎;) 目录 材料...

a201577f0546
2017/12/21
0
0
使用 sphinx 制作简洁而又美观的文档

简介: 学习如何使用 Sphinx 工具创建能够以各种格式(如 HTML)自动进行分布的可维护的、样式支配的文档。 简介 Sphinx 是一种工具,它允许开发人员以纯文本格式编写文档,以便采用满足不同...

IBMdW
2012/01/18
1K
0
Hexo搭建Github-Pages博客填坑教程

目录: 1.安装Hexo 2.部署Hexo 3.Hexo命令 4.一些报错处理 5.博客管理 6.插件(RSS、Sitemap) 7.评论设置 8.404页面 9.统计 10.更新 11.总结 12.参考引用 13.搭建博客相关网站 简述 本文主要...

ihtcboy
2015/09/06
0
0
python sphinx 自动化文档的用法

安装 直接使用 pip3 install sphinx 即可 开始 建一个存放文档的 docs 目录,进入 docs 目录执行: sphinx-quickstart 填写信息的按自己的清空填写即可,有两个插件在安装过程中需要启用: autod...

漫步海边小路
2018/08/29
81
1
搭建个人博客 WordPress

大纲: 一、概述 二、LAMP环境 三、安装WordPress 注,操作系统: CentOS 6.5 x86_64(64位)。 一、概述 WordPress 是一款非常流行的开源博客应用,用户可以在支持PHP和MySQL数据库的服务器...

skypeGNU1
2016/03/29
0
0

没有更多内容

加载失败,请刷新页面

加载更多

BigDecimal 去后面无用的0的方法

BigDecimal a=new BigDecimal("0.1000"); System.out.println(a.stripTrailingZeros().toPlainString());...

xiaodong16
12分钟前
4
0
JAVA--高级基础开发

[集合版双色球] 十二、双色球规则:双色球每注投注号码由6个红色球号码和1个蓝色球号码组成。红色球号码从1—33中选择;蓝色球号码从1—16中选择;请随机生成一注双色球号码。(要求同色号码...

李文杰-yaya
昨天
13
0
聊聊rocketmq broker的CONSUMER_SEND_MSG_BACK

序 本文主要研究一下rocketmq broker的CONSUMER_SEND_MSG_BACK CONSUMER_SEND_MSG_BACK rocketmq/common/src/main/java/org/apache/rocketmq/common/protocol/RequestCode.java public class......

go4it
昨天
3
0
API常见接口(下)

system类 StringBuilder和StringBuffer 包装类 1.System类 (java.lang包中) 提供了大量的静态方法,可以获取与系统相关的信息或系统级操作。 常用方法: public static long currentTimeMi...

Firefly-
昨天
4
0
MySQL系列:一句SQL,MySQL是怎么工作的?

对于MySQL而言,其实分为客户端与服务端。 服务端,就是MySQL应用,当我们使用net start mysql命令启动的服务,其实就是启动了MySQL的服务端。 客户端,负责发送请求到服务端并从服务端获取数...

杨小格子
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部