跳转至

GitHub个人主页

本章节将指导你如何创建GitHub Pages个人主页仓库，并将Pelican生成的静态网站内容上传到GitHub。

GitHub Pages简介

GitHub Pages是GitHub提供的一项免费静态网站托管服务，可以直接从GitHub仓库生成网站。它特别适合：

  • 个人博客
  • 项目文档
  • 个人简历
  • 作品集展示

对于个人网站，我们需要创建一个特殊的仓库，名称必须是<你的GitHub用户名>.github.io。例如，如果你的GitHub用户名是zhang-san，那么仓库名应该是zhang-san.github.io。

创建GitHub个人主页仓库

步骤1：登录GitHub

  1. 打开浏览器，访问 GitHub
  2. 使用你的GitHub账号登录

步骤2：创建新仓库

  1. 点击右上角的"+"图标，选择"New repository"
  2. 在"Repository name"中输入<你的GitHub用户名>.github.io
  3. 选择"Public"（公开，免费用户必须选择此选项才能使用GitHub Pages）
  4. 不需要勾选"Add a README file"
  5. 点击"Create repository"按钮创建仓库

步骤3：初始化本地仓库

在服务器上执行以下命令，将创建一个本地Git仓库，并与远程GitHub仓库关联：

# 创建一个新目录
mkdir <你的GitHub用户名>.github.io

# 进入该目录
cd <你的GitHub用户名>.github.io

# 初始化Git仓库
git init

# 创建一个简单的README文件（可选）
echo "# 我的个人主页" > README.md

# 添加远程仓库
git remote add origin git@github.com:<你的GitHub用户名>/<你的GitHub用户名>.github.io.git

上传Pelican生成的静态文件

我们将使用Pelican生成的静态文件作为我们的个人主页内容。

步骤1：生成最新的静态文件

首先，确保你已经生成了最新的Pelican静态网站文件：

# 进入另一个终端窗口，切换到Pelican项目目录
cd ~/mini_resume

# 激活Conda虚拟环境
conda activate ./env  # 如果你使用的是路径环境
# 或
conda activate pelican-env  # 如果你使用的是命名环境

# 生成静态文件
pelican content

现在，在output目录中应该包含了所有生成的静态网站文件。

步骤2：复制静态文件到GitHub仓库目录

# 回到GitHub Pages仓库目录
cd ~/<你的GitHub用户名>.github.io

# 复制Pelican生成的所有静态文件到仓库目录
cp -r ~/mini_resume/output/* .

使用Git命令上传内容

步骤3：添加文件到Git

首先查看当前状态，确认哪些文件需要添加：

git status

添加所有文件到Git暂存区：

git add .

步骤4：提交更改

将所有更改提交到本地仓库：

git commit -m "添加个人网站内容"

步骤5：推送到GitHub

将本地提交的内容推送到GitHub远程仓库：

git push -u origin main  # 或 git push -u origin master（取决于你的默认分支名称）

注意：如果你遇到错误提示默认分支不是main或master，请使用Git提示的分支名称。

访问你的个人网站

上传成功后，GitHub会自动开始部署你的网站。部署通常需要几分钟时间。

完成后，你可以通过以下URL访问你的个人网站： 

https://<你的GitHub用户名>.github.io

更新网站内容

以后当你需要更新网站内容时，只需重复以下步骤：

  1. 在Pelican项目中更新内容（修改Markdown文件等）
  2. 重新生成静态文件（pelican content）
  3. 将新生成的文件复制到GitHub仓库目录
  4. 添加、提交并推送更改：
cd ~/<你的GitHub用户名>.github.io
cp -r ~/mini_resume/output/* .
git add .
git commit -m "更新网站内容"
git push

小结

恭喜！你已经成功地：

  1. 创建了GitHub Pages个人主页仓库
  2. 使用Pelican生成了静态网站内容
  3. 将内容上传到GitHub，发布了你的个人网站

现在，你拥有了一个专业的个人网站，可以用来展示你的简历、作品集或其他内容。这个网站完全由你控制，你可以随时更新内容。

通过这个实践，你学习了Git的基本操作、GitHub Pages的使用，以及如何部署静态网站。这些都是现代开发者的重要技能。