GitHub Pages 配置
GitHub Pages 是一个方便开发者和用户发布静态网页的服务,本文将介绍如何配置 GitHub Pages,以及如何使用 Jekyll 或其他静态网站生成工具进行网站发布。
1. 什么是 GitHub Pages?
GitHub Pages 是 GitHub 提供的免费静态网页托管服务,允许用户直接通过 GitHub 仓库发布个人、项目或组织网站。它通过托管静态文件(如 HTML、CSS、JavaScript)来展示内容,并支持一些高级功能,如 Jekyll 动态网站生成工具。
2. 开始配置
2.1 创建 GitHub 仓库
- 登陆 GitHub 后,点击 New Repository 创建一个新的仓库。
- 仓库命名规则:
- 个人主页的仓库名称必须是
your-username.github.io
,例如GwanSY.github.io
。 - 项目页面可以是任意名字,但要与项目相关。
- 个人主页的仓库名称必须是
2.2 激活 GitHub Pages
- 进入 GitHub 仓库的设置页面 (Settings)。
- 滑动至 Pages 部分。
- 在 Source 下拉菜单中,选择
main
分支,并保存(Save)。 - 本人使用的模板 Chirpy Starter: 点击按钮 ‘Use this template’ > ‘Create a new repository’,新仓库名为
USERNAME.github.io
,其中USERNAME
是你的 GitHub username。
3. 使用 Jekyll 定制 GitHub Pages 网站
Jekyll 是 GitHub Pages 支持的静态网站生成工具。它允许你使用模板生成 HTML 内容,极大地提高了页面创建的效率。更多信息可以参考:Jekyll中文文档、Jekyll英文文档、Jekyll主题列表。
3.1 安装 Jekyll
在本地使用 Jekyll 进行开发需要安装 Git+Ruby+RubyGems。
详细安装教程可以参考以下步骤:
- 下载 Ruby,下载 RubyGems。
- Ruby 和 RubyGems 安装教程:安装教程。
- 在命令行中进入仓库目录。
- 切换镜像源:
1 2
gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/ gem sources -l
- 安装 jekyll:
1
gem install jekyll
- 安装 jekyll-paginate:
1 2
gem install jekyll-paginate jekyll -v <!-- 验证 -->
- 安装 Bundler:
1
gem install bundler
- 本地启动服务:
1
jekyll server
- 查看网站: 打开浏览器并访问
127.0.0.1:4000
或localhost:4000
。
3.2 自定义 GitHub Pages
更换主题。GitHub Pages 提供了一些默认的 Jekyll 主题,你可以在 GitHub 仓库的 ‘_config.yml’ 文件中设置主题。例如:’theme: jekyll-theme-cayman’,你也可以从第三方网站Jekyll主题列表下载主题,并将其添加到项目中。
3.3 部署到GitHub Pages
1
2
3
1. git add "具体文件"
2. git commit -m "first commit"
3. git push origin main
检查你远端仓库已经跟你本地是否同步了,然后在浏览器里输入 ‘username.github.io’ ,就可以访问你的博客了。
4 编写文章
所有的文章都是 _posts 目录下面,文章格式为 markdown 格式。
直接从 _posts/ 目录下创建新的markdown文件 ,修改名字为 2016-10-16-article1.markdown ,注意:文章名的格式前面必须为 2016-10-16- ,日期可以修改,但必须为 年-月-日- 格式,后面的 article1 是整个文章的连接 URL,如果文章名为中文,那么文章的连接URL就会变成这样的,中文字符会经过转义:https://baixin.io/2015/08/HEXO%E6%90%AD%E5%BB%BA%E4%B8%AA%E4%BA%BA%E5%8D%9A%E5%AE%A2/, 所以建议文章名最好是英文的或者阿拉伯数字。 双击 2016-10-16-article1.markdown 打开。
1
2
3
4
5
6
7
---
title:云端Docker搭建ABY库以及本地CLion远程开发
date: 2023-04-03 16:30:00 +0800
categories:[Cyber Engineering]
tags:[Cyber Engineering]
pin: false
---
- title: 显示的文章名, 如:title: 我的第一篇文章
- date: 显示的文章发布日期,如:date: 2016-10-16
- categories: tag标签的分类,如:categories: 随笔
如果你对 markdown 语法不熟悉的话,可以看看作业部落的教程