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]

—然後，如果需要任何更正，請手動編輯存檔檔案。