GitHub Pages博客全教程

"GitHub Pages Blog"

Posted by 王樂 on November 22, 2018

“Happy Birthday.”

前言

2018年国庆从贵州旅行回到深圳,一直想有个地方可以写点东西。

于是乎翻出注册已久的域名 wangle.pub 开始折腾,花了一天时间终于 LeW Blog 开通了。

搭建博客我主要选择的 GitHub Pages + Jekyll 技术方案。

原因如下:

  • Markdown — 已融入到程序生涯中,具备优雅的写作体验。
  • 免费 — 利用 GitHub Pages 的域名和免费无限空间,不用自己采购云主机。
  • Git工作流 — 非常熟悉的程序流程,Git Commit + Push 即可发布博文。

简介

本教程记录如何在GitHub上搭建博客。从中可以掌握部分GitHub Pages功能,Jekyll软件的基本用法,以及Disqus评论系统的基本用法。

GitHub Pages

GitHub 是通过Git进行版本控制的软件源代码托管服务,允许个人用户创建公开的代码仓库。号称程序员界的 Facebook,事实上它已成为了世界上最大的代码存放网站和开源社区。 GitHub 设计了 GitHub Pages 功能允许用户为自己的项目提供网页展示,来替代默认的代码列表。GitHub Pages 可以被认为是用户编写的,托管在 GitHub 上的静态网页。

Jekyll

Jekyll (发音/’dʒiːk əl/,“杰克尔”)是一个静态网页的生成工具,不需要数据库支持。可以免费部署在 GitHub 上,而且可以绑定自己的域名。

Disqus

Disqus 是一家第三方社会化评论系统,主要为网站提供评论托管服务。

开始搭建

安装Jekyll

Jekyll 中文文档,英语水平一般的福利。 我的办公环境是 Windows 系统,所以下面我讲述的是 Jekyll 在 Windows 下的安装指南。

安装Ruby

  • 下载 Ruby 安装包,建议下载Ruby+Devkit,根据你的系统版本进行选择,我是64位操作系统,所以选择 x64 版本。
  • 下载后双击rubyinstaller-devkit-x.x.x.x-x64.exe进行安装,安装最后一步选择继续安装MSYS2,最后选择输入3(msys2 and mingw development toolchain)。

使用命令行安装 Jekyll

1
gem install jekyll

所有Jekyll的依赖包都会被自动安装。

注册 GitHub 账号

要使用 GitHub Pages 服务,首先要注册一个 GitHub 账号。

创建一个项目仓库

仓库名为你的GitHub用户名.github.io,例如:wllyy189.github.io

导入仓库模版

可下载该仓库 startbootstrap-clean-blog-jekyll 代码,导入到刚刚创建的博客仓库中。感谢这个作者。

这时如果安装好了 Jekyll,只需要在该仓库目录下的命令行输入 jekyll serve 就能在本地浏览器预览主题。

注册 Disqus 帐号

为了给 Blog 加上评论系统,需要一个第三方的服务,可选择 DisqusDuoshuoGitalk。我选择的是 Disqus。

注册好 Disqus 帐号后需要在账户下创建一个站点:

配置个人信息:

记录好Shortname

配置授信域名:

到此 Disqus 帐号及配置已基本准备完毕。

注册 百度统计 帐号

如需要给自己的博客加上统计分析,则可以集成 Baidu AnalyticsGoogle Analytics。我使用的是百度。

注册好百度统计帐号,新增一个和你博客地址对应的站点。

记录好track_id

配置 Blog

Jekyll 网站的基本结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
├── _config.yml
├── _drafts
|   ├── begin-with-the-crazy-ideas.textile
|   └── on-simplicity-in-technology.markdown
├── _includes
|   ├── footer.html
|   └── header.html
├── _layouts
|   ├── default.html
|   └── post.html
├── _posts
|   ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
|   └── 2009-04-26-barcamp-boston-4-roundup.textile
├── _data
|   └── members.yml
├── _site
└── index.html

主要记住以下几点基本满足日常使用:

  • _config.yml全局配置文件
  • _posts 这里放的就是你的文章了。文件格式很重要,必须要符合:YEAR-MONTH-DAY-title.MARKUP

_config.yml 配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# 站点设置
title: LeW Blog # 博客标题
SEOTitle: 樂的博客 | LeW Blog # 显示在浏览器上搜索的时候显示的标题
header-img: img/post-bg-css.jpg # 首页头部背景图
email: 87292008@qq.com # 邮箱地址
description: "这里是 @LeW王樂 的个人博客。"
keyword: "王樂的博客, LeW Blog"
url: "https://wangle.pub" # 站点地址, for absolute URL
baseurl: "" # for example, '/blog' if your blog hosted on 'host/blog'
github_repo: "https://github.com/wllyy189/wllyy189.github.io.git" # you code repository

# 侧边栏设置
sidebar: true # 是否开启侧边栏                           
sidebar-avatar: /img/avatar-lew.jpg # 个人头像
sidebar-about-description: "世界那么大,我想出去看看。" # 个人简介

# 社交配置
RSS: false # 是否开启rss
zhihu_username:  # 知乎用户名
github_username:  # GitHub 用户名
jianshu_username:   # 简书用户名

# 评论设置
# Disqus(https://disqus.com/)
disqus_username: wangle-pub # 前文记录的Shortname

# 统计设置
# Baidu Analytics
ba_track_id: 111af758c93fe1bb0cb285baff48a6ef # 前文记录的ba_track_id

修改完成后提交到 GitHub 则已完成基本配置,博客已可访问。

写文章

发表文章一般用markdown格式写好放在_posts目录下。 一般文件头配置:

1
2
3
4
5
6
7
8
9
10
11
---
layout: post
title: "标题"
subtitle: " 子标题"
date: 2018-11-22 15:00:00 # 写作日期
author: "作者名"
header-img: "assets/20181122/post-bg-20181005.jpg" # 文章头部背景图地址
catalog: true # 是否开启目录
tags: # 标签
    - 笔记
---

进阶篇

自定义域名

首先,你必须购买一个自己的域名,可在阿里云进行购买。

添加 CNAME 文件

在 blog 仓库下面添加 CNAME 文件,文件内容为你购买的域名,例如:wangle.pub

解析域名

注册好域名后,需要将域名解析到你的博客上。 管理控制台 → 域名:

分别添加两个 CNAME 记录类型 www@ 指向到你博客的 GitHub 域名:

HTTPS 配置

如果需要配置 https,可以在 GitHub 仓库的 settings 中进行配置,勾选 Enforce HTTPS