利用github搭建项目主页

制作github托管的project page

概述

由于项目需求,需要给项目做一个展示主页,本文主要记录我使用Jekyll和github搭建Github project page的全过程;

先验知识

Github page

github仅允许用户创建一个个人或组织主页(以用户名.github.io为仓库名),但允许用户创建N个项目主页,浏览器访问地址为用户名.github.io/项目名;

而gitthub为了方便用户部署项目主页,提供了许多Jekyll主题模板;这里,使用比较常见的The Cayman theme

Jekyll

Jekyll是一款静态网站生成工具,允许用户使用HTML、Markdown或Textile通过模块的方式建立所需网站,然后通过模板引擎Liquid(Liquid Templating Engine)来运行或者生成对应的静态网站文件。

Jekyll在GitHub上使用较多,通过GitHub搭建自己的博客很多就是使用Jekyll;因为GitHub的渲染引擎默认为Jekyll。当然,也有很多用户使用Hexo不部署个人主页,可以在本地编译好网页后上传到github托管,这里就不再赘述,详情参考该文章

本地配置

环境配置

1,安装Ruby

Jekyll是一款基于Ruby的插件,安装Ruby是必须的.

下载链接中选择推荐版本安装即可,

安装完后弹出 CMD 安装 MSYS2 的窗口,选择关闭即可,不影响后续配置;

命令行输入查看是否安装完成:

1
2
ruby -v
gem -v

2,安装bundler

1
gem install bundler

bundler:The best way to manage a Ruby application’s gems

3,安装 jekyll

1
gem install jekyll

搭建项目

1,在任意文件夹下,创建一个模板,输入以下命令

1
jekyll new project-name

如果想要用其他模板,比如,我想要搭建一个项目的主页,参考模板The Cayman theme,将其clone到本地,cd到该文件夹中即可,进而继续后续操作;

2, 在该文件中,安装依赖,命令行中运行:

1
bundle install

3,启动服务,输入以下命令:

1
jekyll server

4,在本地浏览网页,进去浏览器,输入http://localhost:4000/,你就可以浏览主页了。

本地编译好之后呢,会在根目录看到一个_site的文件夹,里面就是编译好的网站文件,但是呢,如果你进入该文件夹,点击index.html,你会发现网站的风格有问题,那是浏览器没有找到对应Style样式,你可以用编辑器打开index.html找到 stylesheet这一行,改为如下即可,这样就能用相对路径关系找到对应的样式文件了:link rel=”stylesheet” href=”assets/css/style.css”;

部署到Github

到现在为止,我们已经能在本地部署项目主页了,那么下一步就是如何将本地的主页部署到github上,让github托管我们的主页。

1,新建一个仓库,仓库名可以是项目名;

2, 点进仓库,点击右侧的Setting,页面下拉到Github Pages部分,在source中我们选择master branch,项目主页将会从该分支创建出来;

3,clone仓库并更新仓库

你将远程仓库clone到本地后,进入根目录,将之前在本地编译好的_site文件中的所有文件拷贝到该目录中;

4,推上云端,浏览网页

然后再git三连(add,commit,push),这时内,你的网页就被推上云端了,过个几秒钟,你再访问用户名.github.io/仓库名,就能看到与本地部署一样效果的网页啦。

参考

博客-使用 Jekyll 搭建 Github Pages 个人博客

GitHub 托管项目主页