如何使用 GitHub Pages?

GitHub 是一个“社交编码”网站。它允许您上传代码仓库,以便存储在 Git 版本控制系统中。然后,您可以协作开发代码项目,而且该系统默认是开源的,这意味着世界上任何人都可以在 GitHub 上找到您的代码、使用它、从中学习并对其进行改进。您也可以对别人的代码做同样的事情!本文提供了使用 GitHub 的 gh-pages 功能发布内容的基本指南。

发布内容

GitHub 是一个非常重要且有用的社区,值得您参与其中,而 Git/GitHub 是一个非常流行的 版本控制系统 — 现在大多数科技公司都在其工作流程中使用它。GitHub 有一个非常有用的功能,称为 GitHub Pages,它允许您将网站代码实时发布到 Web 上。

GitHub 基本设置

  1. 首先,在您的机器上安装 Git。这是 GitHub 在其之上运行的底层版本控制系统软件。
  2. 接下来,注册一个 GitHub 账户。这很简单,也很方便。
  3. 注册完成后,使用您的用户名和密码登录 github.com

准备上传您的代码

您可以在 GitHub 仓库中存储任何您喜欢的代码,但要充分利用 GitHub Pages 功能,您的代码应构建成一个典型的网站结构,例如,主入口文件为名为 index.html 的 HTML 文件。

在继续之前,您需要做的另一件事是将您的代码目录初始化为一个 Git 仓库。要做到这一点

  1. 将命令行指向您的 test-site 目录(或您为包含您网站的目录起的任何名称)。为此,请使用 cd 命令(即“change directory” - 更改目录)。如果您已将网站放在桌面上的一个名为 test-site 的目录中,您需要输入以下内容:

    bash
    cd Desktop/test-site
    
  2. 当命令行指向您的网站目录内部时,键入以下命令,该命令指示 git 工具将该目录转换为一个 git 仓库

    bash
    git init
    

关于命令行界面的一点题外话

将代码上传到 GitHub 的最佳方式是通过命令行 — 这是一个您可以键入命令来执行创建文件和运行程序等操作的窗口,而不是在用户界面中进行点击。它看起来会像这样:

Terminal/command prompt opened. No command has been entered.

注意:如果您觉得命令行令您不舒服,也可以考虑使用 Git 图形用户界面来完成相同的工作。

每个操作系统都自带命令行工具

  • Windows:可以按 Windows 键,键入Command Prompt,然后从出现的列表中选择它来访问命令提示符。请注意,Windows 有自己的命令约定,与 Linux 和 macOS 不同,因此下面的命令在您的机器上可能会有所不同。
  • macOS:可以在应用程序 > 实用工具中找到终端
  • Linux:通常您可以使用 Ctrl + Alt + T 调出终端。如果这不起作用,请在应用程序栏或菜单中查找终端

这开始时可能有点令人生畏,但别担心 — 您很快就会掌握基本知识。您通过在终端中键入命令并按 Enter 来告诉计算机执行某项操作,如上所示。

为您的代码创建仓库

  1. 接下来,您需要创建一个新的仓库来存放您的文件。点击 GitHub 主页右上角的加号 (+) ,然后选择新建仓库
  2. 在此页面上,在仓库名称框中,输入您的代码仓库的名称,例如 my-repository
  3. 同时填写一个描述,说明您的仓库将包含什么内容。您的屏幕应该看起来像这样: 在浏览器中打开了新建仓库页面,已填写了仓库所有者和仓库名称,可选描述也已填写。勾选了“公开”复选框,“私有”复选框未勾选,初始化仓库时是否包含 README 文件也是如此。
  4. 点击创建仓库;这应该会带您到以下页面: 在浏览器中打开了仓库页面,在 GitHub 头部(包括搜索栏和导航链接到仓库的拉取请求、问题和 gist)下方。导航链接旁边是通知铃铛和您的账户链接。下面是所有者仓库名后跟一个斜杠和仓库名。下方是包含仓库相关不同选项卡的水平导航栏,显示的是“代码”选项卡,并显示如何创建仓库或如何使用命令行推送的文档。

将文件上传到 GitHub

  1. 在当前页面上,您感兴趣的部分是…或从命令行推送现有仓库。您应该在此部分看到两行代码。复制第一行的全部内容,粘贴到命令行中,然后按 Enter 键。命令应该看起来像这样:

    bash
    git remote add origin https://github.com/chrisdavidmills/my-repository.git
    
  2. 接下来,键入以下两个命令,每键入一个后按 Enter 键。这些命令会准备代码上传到 GitHub,并要求 Git 管理这些文件。

    bash
    git add --all
    git commit -m 'adding my files to my repository'
    
  3. 最后,通过转到您正在查看的 GitHub 网页,并在终端中输入我们在…或从命令行推送现有仓库部分看到的第二个命令,将代码推送到 GitHub。

    bash
    git push -u origin main
    
  4. 现在您需要为您的仓库启用 GitHub Pages。为此,请从您的仓库主页选择设置,然后从左侧边栏中选择Pages。在下方,选择“main”分支。页面应该会刷新。

  5. 再次转到 GitHub Pages 部分,您应该会看到一行形式为“您的站点已准备好在 https://xxxxxx 发布。”

  6. 如果您点击这个 URL,您应该会看到您的示例的实时版本,前提是主页名为 index.html — 它默认会转到这个入口点。如果您的网站入口点名称不同,例如 myPage.html,您需要转到 https://xxxxxx/myPage.html

进一步了解 GitHub

如果您想对您的测试网站进行更多更改并将其上传到 GitHub,您需要像以前一样修改您的文件。然后,您需要输入以下命令(每输入一个后按 Enter 键)将这些更改推送到 GitHub:

bash
git add --all
git commit -m 'another commit'
git push

您可以将 another commit 替换为更合适的短语来描述您所做的更改。

我们才刚刚触及 Git 的表面。想了解更多,请查看我们的 Git 和 GitHub 页面。