利用jekyll在github pages上搭建個人博客

標簽: 前端開發(fā)


github pages

github page是github提供的一種可以顯示自己git庫上網(wǎng)頁的服務(wù)。


如何使用githbu pages

有兩種方法:
第一種,在github上創(chuàng)建新的倉庫,命名為username.github.io,username就是自己注冊的用戶名,master分支根目錄上創(chuàng)建index.html。打開網(wǎng)頁username.github.io,就可以看見新建的index.html。

第二種,沒有命名限制,可以基于現(xiàn)有的庫來創(chuàng)建,當(dāng)然也可以開新的倉庫 。新建orphan分支git checkout --orphan gh-pages,分支名一定要是gh-pages。然后在username.github.io/reposname上就可以看見根目錄上的index.html,reposname就是庫名。


什么是jekyll

Jekyll 是一個簡單的博客形態(tài)的靜態(tài)站點生產(chǎn)機器。它有一個模版目錄,其中包含原始文本格式的文檔,通過 Markdown (或者 Textile) 以及 Liquid 轉(zhuǎn)化成一個完整的可發(fā)布的靜態(tài)網(wǎng)站,你可以發(fā)布在任何你喜愛的服務(wù)器上。Jekyll 也可以運行在 GitHub Page 上,也就是說,你可以使用 GitHub 的服務(wù)來搭建你的項目頁面、博客或者網(wǎng)站,而且是完全免費的。

以下是內(nèi)容都是介紹jekyll的簡單用法,詳細請看官方文檔


使用jekyll在github上搭建個人博客

github pages 支持jekyll,因此可以直接將源碼上傳到github pages上,會自動解釋并生成網(wǎng)頁。

1.目錄結(jié)構(gòu)

mulu.png

_name 的是jekyll的默認文件/文件夾,可通過liquid讀取
_data/ 里面的文件可通過site.data.xx來讀取
_includes/ 里面的文件可被引用到模板上
_layouts/ 模板存放的地方
_posts/存放博文,可通過page.xx來讀取相應(yīng)數(shù)據(jù)
_site/運行生成的文件存放在這里,自動生成
_config.yml配置文件,里面的屬性可通過site.xx來讀取
index.html主頁
404.html一定要是404.html才能作為404頁面

liquid的語法可參見該文: liquid用法筆記

2.配置文件_config.yml
有很多配置,詳細參見官方文檔,簡單的配置如下

encoding: utf-8 //網(wǎng)頁的編碼
baseurl: /reposname //用于site.baseurl, 適應(yīng)github pages的路徑, 不過好像不用這個,直接用相對路徑可以。
permalink: pretty  //生成路徑的方法,詳細見文檔
markdown: kramdown //github 指定的markdown內(nèi)核
kramdown:
  input: GFM  //github markdown 寫法

3.模板_layouts
_layouts/下新建default.html

<!DOCTYPE html>
<html >
<head>
    <title>{{page.title}}</title>
       <!--  調(diào)用page.title變量 -->
</head>

<body>
    <main class="container">
        <div class="wrapper">
            {{content}}
 <!--  調(diào)用該模板的文件的主內(nèi)容全部顯示在content里 -->
        </div>
    </main>

    {% include sidebar.html %}
<!--  引用_include/sidebar.html -->

</body>
</html>

4.index.html

---
layout: default
title: Hello World
---
<p>hello world</p>
<!-- 
虛線中間layout 表示要調(diào)用的模板,其他變量可通過page.xxx來引用。
虛線下面的內(nèi)容為主內(nèi)容,顯示在content中。
-->

現(xiàn)在打開github page上的網(wǎng)頁(username.github.io 或者 username.github.io/reposname 視乎你用哪種方法創(chuàng)建github pages)應(yīng)該就能看見hello world。

5.post博文
_posts文件夾里創(chuàng)建文件2016-05-01-this-is-post.html
注意post的命名格式是yyyy-mm-dd-title.html/md,之后生成鏈接可以用post.url來指向博文

//2016-05-01-this-is-post.html
---
layout: default
title: this is post 1
---
<p>this is post one</p>

修改index.html,加入新博文的鏈接

//index.html
---
layout: default
title: Hello World
---
<h1>hello world</h1>
{% for post in site.posts %}
  <a href="{{ site.baseurl }}{{ post.url }}"> {{post.title}}</a>
  {% comment %} 
  注意site.baseurl 與 post.url中間沒有 "/" ,因為post.url自帶了"/"
  {% endcomment %}
{% endfor %}

6.命令行

jekyll serve --baseurl "" --watch #本地測試
jekyll build #生成文件

--baseurl "" 是為了發(fā)布的地址設(shè)為/,方便測試
--watch 就是自動監(jiān)控文件變化了,使用中文件是刷新了,但網(wǎng)頁不會自動刷新,需要配合gulp和chrome插件LiveReload來使用,gulp的配置可以參考我的。

var gulp = require('gulp'),
    refresh = require('gulp-refresh');

gulp.task('refresh', function(){
  refresh.listen();
  gulp.watch('blogJekyll/_site/**/*.*', function(){
    gulp.src('blogJekyll/_site/**/*.*')
    .pipe(refresh());
  });
});

build之后可以將_site文件夾內(nèi)里的內(nèi)容發(fā)布到gh-pages上,然后上http://username.github.io/baseurl/就可以看到了,不過好像github支持解析jekyll,只要直接將完整的項目上傳到gh-pages上就可以

7.語法高亮
想要引用的代碼塊語法高亮,要引用外部的資源

<link rel="stylesheet" >
<script src="http://yandex.st/highlightjs/7.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>

這樣就有語法高亮了,其實也可以根據(jù)生成后的DOM元素自己加CSS.
例如code { background: #f0f0f0 ;}


結(jié)束

以上就是jekyll的簡單用法,大家可以看看我創(chuàng)建的博客,很簡單的,一看就懂。
源碼點這里

也可以看看別人的jekyll模板

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,923評論 6 535
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,740評論 3 420
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,856評論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,175評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 71,931評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,321評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,383評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,533評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,082評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,891評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,067評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,618評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,319評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,732評論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,987評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,794評論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 48,076評論 2 375

推薦閱讀更多精彩內(nèi)容