在 GitHub 上托管¶

创建一个与 shard.yml 中指定的 name 和 description 相同的仓库。

添加并提交所有内容

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

添加远程： (请务必根据情况替换 <YOUR-GITHUB-USERNAME> 和 <YOUR-REPOSITORY-NAME>)

注意

如果您愿意，可以自由地用 origin 或您选择的远程名称替换 public。
```
$ git remote add public https://github.com/<YOUR-GITHUB-NAME>/<YOUR-REPOSITORY-NAME>.git
```
推送它
```
$ git push public master
```

GitHub 版本¶

进行 GitHub 版本是一个好习惯。

在您 README 中的描述下方添加以下 Markdown 构建徽章，以告知用户当前的最新版本是什么： (请务必根据情况替换 <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 Shard 的 README，

当从 Git 仓库安装库时，仓库应具有以 v 为前缀的符合 semver 格式的版本标签。示例： 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 的替代方案。