如何使用 Python在30 分鐘內快速搭建博客?
10個優秀的程序員里,9個都有寫博客的習慣。
這是非常好的習慣,它使得知識得以提煉,轉輸出為輸入,在提升自己的同時,還能利用互聯網易傳播的特性,將知識分享給每一個熱愛學習的人。所以寫博客,是值得每個程序員投入時間和精力去堅持做下去的事。
博客既然是自己的一個知識寶庫,那麼索引將變得極為重要。通過自己的探索,筆者發現了一個能夠很好地滿足這個需求的 Python 框架 Sphnix。
實現的大體的思路如下:
Markdown:書寫文檔;
Pandoc:格式轉化;
Sphinx:生成網頁;
GitHub:託管項目;
ReadtheDocs:發布網頁。
接下來,就來看看到底是如何實現的?
安裝Sphnix
首先是安裝Sphnix。在安裝前,請確認下Python版本。本文使用的是Python 2.7.14,其他版本請自行嘗試(建議跟筆者一樣使用 Py2,避免踩坑)。
安裝Python工具包:
初始化:
執行命令sphinx-quickstart的時候,會要求輸入配置。除了這幾個個性化配置,其他的都可以按照默認的來:
之後,就可以看見創建的工程文件:
解釋下這些文件/夾:
build:文件夾,當執行make html的時候,生成的html靜態文件都存放在這裡;
source:文件夾,文檔源文件全部應全部放在source根目錄下;
Makefile:編譯文件;
make.bat:bat腳本。
配置及擴展
Sphinx的配置文件是sourceconifg.py。
由於修改的內容多且雜,為了使搭建過程更加順暢,需要進行Sphinx配置,包括配置主題、支持LaTeX以及支持中文檢索等等。
配置文件還需要搭配相應的擴展模塊才能使用,有時候還會用到一些第三方依賴包:
撰寫文章
萬事俱備,接下來就要寫文檔了。
在source目錄下,新增文件how_to_be_a_rich_man.rst。
文件內容如下:
寫好文檔後,千萬記得要把這個文檔寫進目錄排版裡面。
排版配置文件是sourceindex.rst,注意中間的空行不可忽略:
然後刪除這幾行:
然後執行make html生成html靜態文件:
執行完了後,你可以發現原先的build不再是空文件夾了。
我們點進去 buildhtml,打開index.html
點擊我們剛寫的暴富指南:
託管項目
看到網頁的那一刻是不是相當激動?不過別激動,這只是本地的,我們需要將其發布在線上。
這裡筆者將工程文件託管在了GitHub上,然後由Read the Docs發布。
在託管之前還需要些準備工作。在mkdocs根目錄下,添加文件.gitignore(聰明的你,肯定知道這是什麼),內容如下:
接下來,在你的GitHub上新建一個倉庫。然後把mkdocs目錄下的所有文件都提交上去。步驟很簡單,這裡就不再贅述。
發布上線
託管完成後,我們要發布它讓別人訪問。
你需要先去Read the Docs註冊帳號。然後關聯GitHub:
導入代碼庫,填好與你對應的信息:
構建網頁後,右下方可以看見你的在線地址:
這裡要提醒的是,Sphinx文檔默認是rst格式,如果你習慣了使用Markdown來寫文章,可以使用Pandoc這個神器轉換一下。
這裡給出轉換命令:
或者你也可以在Sphinx上添加支持Markdown渲染的擴展模塊及配置,也很簡單。但是,使用md文件在網站上的導航無法實現跳轉。
到這裡,屬於你的個人博客就搭建好了。
成品展示
這是首頁,顯示了所有的文章索引。
這是導航欄,結構很清晰,也很方便索引。
點擊文章後,還可以很方便地查看標題和跳轉。
體驗下搜索功能,速度很快。
看完這些你是不是也很想擁有這樣一個博客呢?快試一下吧。
※編程真可怕,我們日常都在寫 Bug
※華為超蘋果成第一;5G來臨時間已定;谷歌禁止重複內容
TAG:CSDN |