在github上写博客

96
cjzhao
0.1 2016.05.27 13:15* 字数 1830

本文部分内容参考github使用帮助

接触博客是在06年5月份,当时在CSDN上写博客,随着技术的发展,我的博客也经历了几个时代,除了CSDN这样的网站托管方式外,我还经历了租主机空间的时代,VPS主机(云主机)时代,SaaS平台托管时代,github时代。

主机空间时代就是运营商给你一个空间,把你的程序上传到空间,然后给个地址就能跑起来。

VPS(云)主机时代,相当于给你一个操作系统,需要自己安装php运行环境、wordpress程序,有独立的IP地址,需要使用域名解析……

SaaS平台托管时代,就是像新浪SEA,可以在应用商店里选择wordpress程序,轻松点几步就搭建好了博客系统。

当前,对于程序员来说,如果要显得你很专业,很潮的话,当然是直接等托管到github了,所有资源都是免费的,也可以绑定自己的域名。

本节就将介绍"github pages"的功能,最终的目的就是在github上写博客(当然除了博客之外,所有静态站点都能托管到github)。

github pages包括两种类型的静态站点(pages)。

  • 项目类型的pages,对于每一个项目,你可能都要建立一个网站来介绍和宣传你的项目,在github上,你只需要把你的静态内容push到这个项目的gh-pages分支,然后通过http(s)://username(orgname).github.io/projectname就可以直接访问。

  • 用户、组织类型的pages,只需在用户或组织名下,创建一人名为"username(orgname).github.io"的repository后,将静态站点push到master分支,就可以通过域名username(orgname).github.io访问。

使用Automatic page generator功能创建pages

我们将继续用上一节的项目https://github.com/ChangjunZhao/coderbook为例,讲解如何使用Automatic page generator功能创建一个项目的pages(静态站点)。

对于用户、组织类型的pages,需要先创建一个"username(orgname).github.io"的repository。

首先进入项目首页https://github.com/ChangjunZhao/coderbook,如下图所示

repos_setting.png

点击“Settings”按钮,进入repository设置页面,你将看到关于pages的设置项如下图所示:

githubpages.png

这里是关于github pages的简单说明,点击“Automatic page generator”按钮,即进入生成项目静态站点向导。

githubpages_autocreatepages_step1.png

在此页,你可以更改项目名称,Tagline相关于首页的一个副标题,body部分为首页内容,这里使用markdown语法。“Google Analytics Tracking ID”是google网页分析的跟踪ID,建议不填,因为国内用户目前无法使用。

填写完成后点击“continue to layouts”,为你的静态站点选择一个模板。如下图所示:

publish_github_pages.png

选择好你理想的站点模板后,点击上图中绿色的√,您的项目静态站点就生成了。

此时系统自动给您创建了一个gh-pages的分支,保存刚才系统自动生成的静态站点。

github_newbranch_ghpages.png

通过http://Changjunzhao.github.io/coderbook就可以直接访问网站。

如果是用户、组织类型的pages,使用username(orgname).github.io即可访问。

gihub_pages_coderbook.png

OK,剩下的工作就是把gh-pages分支clone到本地来,发挥你的才能做你的网站,搞完之后再push到github的gh-pages分支,更改会立即生效(国内会有短时延迟)。

手工创建pages

通过前面的学习,你应该自己能想到如何通过手工创建pages,其实很简单,只需要手工创建一个gh-pages分支,在这个分支里开发你的静态站点,然后push到github就可以了。

整个过程的命令如下(没有验证过,遇到问题学会自己想办法解决吧):

git checkout --orphan gh-pages #这里--orphan指独立分支,不会把当前分支内容添加到新的分支
git rm -rf .
echo "My GitHub Page" > index.html
git add index.html
git commit -a -m "First pages commit"
git push origin gh-pages

使用Jekyll搭建博客系统

Transform your plain text into static websites and blogs.

Jekyll是一个将纯文本转换成静态站点或blog的工具。

github pages对Jekyll提供原生支持,可以免费将你的blog托管到github pages。

废话不说,如果想详细了解Jekyll,请到官网:http://jekyllrb.com/

下面我们就开始建我们的blog吧。

安装Jekyll

这里以ubuntu为例,其它操作系统举一反三。

Jekyll是用ruby开发的,所有安装Jekyll之前需要执行下面的命令安装一些依赖。

sudo apt-get install ruby ruby1.9.1-dev nodejs

安装Jekyll:

sudo gem install jekyll

Jekyll基础

我们将为ChangjunZhao创建一个blog,并托管到github。

在命令行执行如下命令生成Jekyll基本目录结构:

jekyll new ChangjunZhaoBlog

cd ChangjunZhaoBlog

执行tree命令,可看到完整的Jekyll目录如下图所示:

jekyll_tree.png
文件/目录 说明
_config.yml Jekyll配置文件
_drafts 草稿目录
_includes 页头、页脚之类的放于这个目录,可以使用{% include header.html %}这样的标签在别的地方引用
_layouts 这里是存放页面模板的地方,可以在模板中使用{{ content }} 来引用页面内容
_posts 这里就是存放动态的博客内容,标题必须为YEAR-MONTH-DAY-title.MARKUP格式
_data 存放yaml格式的数据文件,比如存了一个members.yml的文件,那么在别的地方可以使用site.data.members引用相关数据
_site 使用Jekyll编译后的静态站点将存放于这个目录下,这个目录不需要push到github,所以要在.gitignore文件中加入这个目录
index.html and other HTML, Markdown, Textile files 首页内容
Other Files/Folders 其它文件和目录会当做静态内容处理

好了,先来看看效果,再简单介绍几个关键的要点吧。

在命令行执行:jekyll server 启动jekyll站点。用浏览器打开http://localhost:4000,如下图所示:

jekyllblog_home.png

我们在_posts目录下,新建文件2014-07-24-changjunzhao-first-blog.md,内容如下:

---
layout: post
title:  "赵昌峻的第一篇blog!"
date:   2014-07-24 10:47:13
categories: other
---
大家好,欢迎来到我的博客,本篇博客将向大家介绍如何在Jekyll中实现代码高亮显示。

假设我们的代码是java的,看看下面的效果还可以吧?

{% highlight java %}
class test{
   public static void main(String[] args){
     System.out.println("hello, world");
   }
}
{% endhighlight %}

当然所有markdown的语法Jekyll都支持哦。

这里layout: post的意思是使用_layouts下的post模板来显示这个blog。

title会作为blog的标题。
date为发表时间。
categories为分类,我们可以使用site.posts.categories这样的标签来引用指定分类的博客。

其它即为使用markdown写的博客内容。

好了,执行jekyll server再看看效果如下:

jekyll_first_blog_index.png

点击“赵昌峻的第一篇blog!”,如下图所示:

jekyll_firstblog.png

好了,关于Jekyll的内容,我不想再写了,再写就成一本介绍Jekyll的书了,还是希望大家到官网http://jekyllrb.com/去看相关的文档,因为Jekyll其实也是一个很高深的东西,能做出很漂亮的网站。比如github官方培训站点:https://training.github.com/,代码在:https://github.com/github/training.github.com/tree/7049d7532a6856411e34046aedfce43a4afaf424

发布到github pages

结合前面讲的github pages你应该已经知道如何发布到github pages了。

只需要把ChangjunZhaoBlog目录下的东西push到gh-pages分支即可,如果是用户、组织类型的,push到master分支。

假设我们把ChangjunZhaoBlog发布到ChangjunZhao.github.io的站点,那么需要进行如下操作。

  1. 创建ChangjunZhao.github.io的repository。

  2. 在ChangjunZhaoBlog目录执行如下命令:

git init
git add .
git commit -m "first blog commit"
git remote add origin git@github.com:ChangjunZhao/ChangjunZhao.github.io.git
git push -u origin master

浏览器打开changjunzhao.github.io就能看到博客内容了。

最后想补充一点: 在“简书”上写写文章也不错哦。


国际范程序必读:
程序员的编辑器-VIM(爱就是爱)
向开源社区贡献您的代码
企业级应用开发和Maven之间的那些事
DevOps是什么东东?
js依赖管理工具bower
JS模块化编程-requirejs

国际范程序员