在 GitHub 上託管¶

建立一個儲存庫，其 name 和 description 與您的 shard.yml 中指定的相同。

新增並提交所有內容

$ git add -A && git commit -am "shard complete"

新增遠端：(請務必將 <YOUR-GITHUB-USERNAME> 和 <YOUR-REPOSITORY-NAME> 替換為您的實際值)

注意

如果您喜歡，可以將 public 替換為 origin，或是您選擇的遠端名稱。
```
$ git remote add public https://github.com/<YOUR-GITHUB-NAME>/<YOUR-REPOSITORY-NAME>.git
```
推送它
```
$ git push public master
```

GitHub 發布¶

進行 GitHub 發布是一個好習慣。

將以下 markdown 建置徽章新增到您 README 中的描述下方，以告知使用者目前最新的版本為何：(請務必將 <YOUR-GITHUB-USERNAME> 和 <YOUR-REPOSITORY-NAME> 替換為您的實際值)

[![GitHub release](https://img.shields.io/github/release/<YOUR-GITHUB-USERNAME>/<YOUR-REPOSITORY-NAME>.svg)](https://github.com/<YOUR-GITHUB-USERNAME>/<YOUR-REPOSITORY-NAME>/releases)

首先，請導覽至您儲存庫的「發布」頁面。您可以在 https://github.com/<YOUR-GITHUB-NAME>/<YOUR-REPOSITORY-NAME>/releases 找到此頁面。

點擊「建立新發布」。

根據 Crystal Shards README，

當從 Git 儲存庫安裝函式庫時，該儲存庫應具有符合 semver 格式的版本標籤，並以 v 作為前綴。例如：v1.2.3、v2.0.0-rc1 或 v2017.04.1

因此，在標示為 tag version 的輸入框中，輸入 v0.1.0。請確保此值與 shard.yml 中的 version 相符。將其標題設為 v0.1.0，並為該版本撰寫簡短的描述。

點擊「發布發布」，您就完成了！

您現在會注意到 GitHub 發布徽章已在您的 README 中更新。

遵循語義化版本，並在每次將新程式碼推送至 master 時建立新的發布。

持續整合¶

GitHub Actions 允許您在每次提交時自動測試您的專案。請依照專用指南設定它。

您也可以在您的 README.md 中的描述下方新增建置狀態徽章。

在 GitHub Pages 上託管您的文件¶

作為 GitHub Actions 設定的擴展，您可以新增步驟來建置 API 文件網站，然後對應地上傳它們

    steps:

      - name: Build docs
        run: crystal docs
      - name: Deploy docs
        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
        uses: ...
        with:
          ...

-- 其中後面的 ... 佔位符號是任何將目錄推送到 gh-pages 分支的通用 GitHub Actions。一些選項如下

這會使用 Crystal 的內建 API 文件產生器，根據您的程式碼以及其中的項目註解來建立通用網站。

除了發布產生的 API 文件之外，也請考慮為您的專案建立完整的文字手冊，以提供完善的介紹。

對於靜態網站產生的一個選項 mkdocs-material，有一個解決方案可以將 API 文件緊密整合到整體文件網站中：mkdocstrings-crystal。請將它視為 crystal docs 的替代方案。