seagl.github.io

海格

这是 https://seagl.org 网站的源代码。

它使用 Jekyll 作为带有 GitHub Pages 的静态站点生成器。

每当代码被推送到 GitHub 上的共享存储库时，该站点就会自动呈现。

基本上，更新网站（例如发布新博客文章）的步骤是：

1. 分叉/克隆存储库，
2. 做出你的改变，
3. 测试你的改变，
4. 发送更改的拉取请求 (PR)，
5. PR 合并后，您的更改将立即发布

以下每个步骤都有说明。这些说明假设由具有较少 git/GitHub/技术经验的人来执行这项工作。经验丰富的人可以据此推断。 :-)

分叉/克隆存储库

虽然您可能可以直接在这个存储库上工作，但最佳实践是您不能。相反，您可以分叉或克隆存储库，然后对该副本进行更改。这允许在进行更改之前进行测试，并降低格式错误或措辞不当的更改泄露出去的风险。

要分叉存储库：

1. 单击页面顶部的叉子。
2. 选择存储库副本的目标帐户/组织。
3. 等待所有内容都复制过来。

瞧！这就是全部内容了。

做出你的改变

如果您要添加新的博客文章，请遵循以下文件名规则：

• 将所有博客文章放在_posts目录中。
• 文件名以YYYY-MM-DD格式的日期开头。这非常重要，因为它控制网站显示博客文章的顺序。
  • 注意：网站将显示截至当前日期（包括当前日期）的帖子。这允许您提前安排帖子，但这也意味着将来的帖子不会出现，除非您在测试更改时使用--future 。目前，您还需要在预定日期或之后触发网站重建才能显示该帖子。这可以通过以下方式完成： git commit -m 'rebuild pages' --allow-empty && git push origin main或对站点进行任何实际更改。
• 日期后面加上破折号 ( - )，然后是破折号分隔的帖子标题。该标题不显示。只是给文件命名而已。请使其简短但具有描述性。
• 使用.md文件扩展名表示帖子以 Markdown 格式撰写。 （并且请仅使用 Markdown 撰写帖子）

根据这些规则，宣布 2017 年 CFP 开幕的博客文章的文件名可以为：

 2017-06-19-CFP-open.md

另请在文件顶部添加以下内容：

 ---
layout: post
title: 'Example Title'
status: publish
type: post
published: true
categories: news
tags: '2013'
---

将title设置为博客文章的标题，并编辑tags以包含与该文章关联的会议年份（如果没有则为空）。请保留其余值不变。

对于实际的文件内容，您可以在 GitHub Web 界面或本地计算机上进行更改。

在 GitHub 上

1. 导航到您要编辑或添加的文件所在的目录（可能是_posts ）。
2. 要创建新文件：
   • 单击Create a new file
   • 命名您的文件（如果是博客文章，请根据上面的说明）
3. 做出你的改变
   • 要创建新文件：
     • 单击Create a new file
     • 输入文件名（如果是博客文章，则根据上面的说明）
   • 要编辑现有文件：
     • 单击该文件以选择它
     • 单击小铅笔图标
   • 无论哪种方式，您现在都可以在 Web 界面中编辑该文件。
4. 使用编辑界面下方的Commit changes表单来提交更改。
   • 输入简短但描述性的标题，例如“添加 2017 年 CFP 开放公告”。
   • 输入详细说明。如果您正在处理某个问题，请在此处引用问题编号。使用井号 ( # ) 后跟问题编号 ( #74 )。这将自动链接到拉取请求中，这非常方便。

在您的本地计算机上

TBD（假设那些在本地计算机上使用 git 的人已经知道这一点；稍后将填写）

1. 克隆你的叉子
2. 进行更改（添加和/或编辑文件）
3. 将您的更改提交回您的分支

测试您的更改

请在推送到 GitHub 之前在本地测试所有更改。

本地开发服务器

启动本地开发服务器将使您的站点副本在 http://localhost:4000 上可用。有几种方法可以运行服务器。任你挑选！

选项 1：裸机

依赖项：

• 红宝石
• 捆绑器

一次性设置：

bundle install

启动服务器：

bundle exec jekyll serve --watch

要预览未来日期和未发布的帖子，请将--future --unpublished添加到上述命令。

选项 2：集装箱化

依赖项：

• Docker（或 Podman；用podman替换docker ）

一次性设置：

docker build --tag ' seagldev ' ' . '

启动服务器：

docker run --rm --interactive --tty --publish ' 4000:4000 ' --volume " $PWD :/usr/src/app " ' seagldev '

要预览未来日期和未发布的帖子，请在上述命令末尾添加--future --unpublished 。

发送更改的拉取请求 (PR)

您可以在 GitHub 界面中或从本地计算机发送 PR。

在 GitHub 上

1. 在浏览器上，导航到seagl.github.io 存储库的分支。
2. 单击Pull requests选项卡。
3. 单击New pull request button 。
4. GitHub 会识别您的存储库是一个分叉，并默认将 PR 设为针对seagl.github.io 主分支请求的分叉的主分支。可能性很大，这就是你想要的。如果不是，您就会足够了解并认识到这一点。 :-)
5. 单击Create pull request 。
6. 输入简短但描述性的标题，例如“添加 2017 年 CFP 开放公告”。
7. 输入详细说明。如果您正在处理某个问题，请在此处引用问题编号。使用井号 ( # ) 后跟问题编号 ( #74 )。这将自动链接到拉取请求中，这非常方便。
8. 选择[Allow edits from maintainers](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)以便其他团队成员可以在必要时进行编辑。
9. 单击Create pull request 。

在您的本地计算机上

TBD（假设那些在本地计算机上使用 git 的人已经知道这一点；稍后将填写）

您的更改将实时发布

现在，有人（也许是您，如果您对存储库具有该级别的访问权限）必须审查并合并您的拉取请求。

一旦您的拉取请求被合并，它将在网站上上线。

注意：合并本身不会触发站点重建。要重建站点，您需要像这样推送一个空提交：

git commit --allow-empty -m " Rebuild the site, please " && git push

如何在帖子中添加图片

将图像添加到img/posts/目录，然后使用以下 Markdown：

 ![ Example description ] ( /img/posts/example.jpg )

尖端：

• 要将图像与侧面对齐，请添加align-left或align-right类：

   ![ Example description ] ( /img/posts/example.jpg ) {:.align-left}

• 为了缩短页面加载时间，请在帖子中使用图像之前将其调整为合理的大小。

过去会议的档案

过去的会议作为 Jekyll 集合静态存档：

• archive-conferences
• archive-sessions

要创建给定年份的档案，首先从时间表导入数据 -

bundle exec rake import[2020]

—然后，如果需要任何更正，请手动编辑存档文件。