10个优秀的程序员里,9个都有写博客的习惯。
这是非常好的习惯,它使得知识得以提炼,转输出为输入,在提升自己的同时,还能利用互联网易传播的特性,将知识分享给每一个热爱学习的人。所以写博客,是值得每个程序员投入时间和精力去坚持做下去的事。
博客既然是自己的一个知识宝库,那么索引将变得极为重要。通过自己的探索,笔者发现了一个能够很好地满足这个需求的Python框架Sphnix。
实现的大体的思路如下:
Markdown:书写文档;Pandoc:格式转化;Sphinx:生成网页;GitHub:托管项目;ReadtheDocs:发布网页。接下来,就来看看到底是如何实现的?
安装Sphnix
首先是安装Sphnix。在安装前,请确认下Python版本。本文使用的是Python2.7.14,其他版本请自行尝试(建议跟笔者一样使用Py2,避免踩坑)。
安装Python工具包:
$pipinstallsphinxsphinx-autobuildsphinx_rtd_theme初始化:
#先创建一个工程目录:F:\\mkdocs$cdF:\\mkdocs$sphinx-quickstart执行命令sphinx-quickstart的时候,会要求输入配置。除了这几个个性化配置,其他的都可以按照默认的来:
Projectname:MINGsBLOGAuthorname(s):MINGProjectrelease[]:1.0Projectlanguage[en]:zh_CN之后,就可以看见创建的工程文件:
F:\mkdocs(mkdocs)λls-ltotal5-rw-r--r--1wangbmJun:57Makefiledrwxr-xr-x1wangbmJun:57build/-rw-r--r--1wangbmJun:57make.batdrwxr-xr-x1wangbmJun:57source/F:\mkdocs(mkdocs)λtree卷文档的文件夹PATH列表卷序列号为-B4B9F:.├─build└─source├─_static└─_templates解释下这些文件/夹:
build:文件夹,当执行makehtml的时候,生成的html静态文件都存放在这里;source:文件夹,文档源文件全部应全部放在source根目录下;Makefile:编译文件;make.bat:bat脚本。
配置及扩展
Sphinx的配置文件是source\conifg.py。
由于修改的内容多且杂,为了使搭建过程更加顺畅,需要进行Sphinx配置,包括配置主题、支持LaTeX以及支持中文检索等等。
配置文件还需要搭配相应的扩展模块才能使用,有时候还会用到一些第三方依赖包:
greenlet==0.4.5oauthlib==0.7.2paho-mqtt==1.0tzlocal==1.1.2redis==2.10.3requests==2.4.3requests-oauthlib==0.4.2whitenoise==1.0.3openpyxl==2.1.5
撰写文章
万事俱备,接下来就要写文档了。
在source目录下,新增文件how_to_be_a_rich_man.rst。
文件内容如下:
第一章如何成为有钱人======================1.1财富继承法---------------------有个有钱的老爸。1.2财富共享法---------------------有个有钱的老婆。写好文档后,千万记得要把这个文档写进目录排版里面。
排版配置文件是source\index.rst,注意中间的空行不可忽略:
..toctree:::maxdepth:2:caption:Contents:how_to_be_a_rich_man然后删除这几行:
Indicesandtables==================*:ref:`genindex`*:ref:`modindex`*:ref:`search`然后执行makehtml生成html静态文件:
F:\mkdocs(mkdocs)λmakehtmlRunningSphinxv1.7.4loadingtranslations[zh_CN]...doneloadingpickledenvironment...donebuilding[mo]:targetsfor0pofilesthatareoutofdatebuilding[html]:targetsfor2sourcefilesthatareoutofdateupdatingenvironment:[extensionschanged]2added,0changed,0removedreadingsources...[%]indexlookingfornow-outdatedfiles...nonefoundpicklingenvironment...donecheckingconsistency...donepreparingdocuments...donewritingoutput...[%]indexgeneratingindices...genindexwritingadditionalpages...searchcopyingstaticfiles...donecopyingextrafiles...donedumpingsearchindexinEnglish(code:en)...donedumpingobjectinventory...donebuildsucceeded.TheHTMLpagesareinbuild\html.执行完了后,你可以发现原先的build不再是空文件夹了。
我们点进去build\html\,打开index.html
点击我们刚写的暴富指南:
托管项目
看到网页的那一刻是不是相当激动?不过别激动,这只是本地的,我们需要将其发布在线上。
这里笔者将工程文件托管在了GitHub上,然后由ReadtheDocs发布。
在托管之前还需要些准备工作。在mkdocs根目录下,添加文件.gitignore(聪明的你,肯定知道这是什么),内容如下:
build/.idea/*.pyc接下来,在你的GitHub上新建一个仓库。然后把mkdocs目录下的所有文件都提交上去。步骤很简单,这里就不再赘述。
发布上线
托管完成后,我们要发布它让别人访问。
你需要先去ReadtheDocs注册帐号。然后关联GitHub:
导入代码库,填好与你对应的信息:
构建网页后,右下方可以看见你的在线