Cayman 主题

Cayman 是 GitHub Pages 的 Jekyll 主题。你可以预览主题以查看其外观，甚至立即使用它。

Cayman 缩略图

使用方法

要使用 Cayman 主题：

在你网站的 _config.yml 中添加以下内容：

remote_theme: pages-themes/cayman@v0.2.0
plugins:
- jekyll-remote-theme # 如果你已经有插件列表，请将此行添加到列表中

如果你想在电脑上预览你的网站，可以选择在网站的 Gemfile 中添加以下内容：
```
gem "github-pages", group: :jekyll_plugins
```

自定义

配置变量

如果在你网站的 _config.yml 中设置了以下变量，Cayman 将会使用它们：

title: [你的网站标题]
description: [你的网站目的的简短描述]

此外，你可以选择设置以下可选变量：

show_downloads: ["true" 或 "false" (不带引号) 表示是否提供下载 URL]
google_analytics: [你的 Google Analytics 跟踪 ID]

样式表

如果你想添加自己的自定义样式：

在你的网站中创建一个名为 /assets/css/style.scss 的文件
在文件顶部添加以下内容，确保内容完全一致：
```
---
---

@import "{{ site.theme }}";
```
在 @import 行之后立即添加任何自定义 CSS（或 Sass，包括导入）

注意：如果你想更改主题的 Sass 变量，必须在样式表的 @import 行之前设置新值。

布局

如果你想更改主题的 HTML 布局：

对于一些更改，比如自定义 favicon，你可以在本地 _includes 文件夹中添加自定义文件。主题提供的文件提供了一个起点，并被原始布局模板包含。
对于更广泛的更改，复制原始模板从主题的仓库中
（专业提示：点击"raw"以便更容易复制）
在你的网站中创建一个名为 /_layouts/default.html 的文件
粘贴在第一步中复制的默认布局内容
根据需要自定义布局

自定义 Google Analytics 代码

自本主题首次创建以来，Google 已经发布了几个版本的 Google Analytics 代码。如果你想使用最新的代码，请将其粘贴到你的 Jekyll 网站的 _includes/head-custom-google-analytics.html 文件中。

覆盖 GitHub 生成的 URL

模板通常依赖 GitHub 提供的 URL，如指向你的仓库的链接或下载你的项目的链接。如果你想覆盖一个或多个默认 URL：

查看模板源代码以确定变量的名称。它将以 {{ site.github.zip_url }} 的形式出现。
在你网站的 _config.yml 中指定你想要模板使用的 URL。例如，如果变量是 site.github.url，你可以添加以下内容：
```
github:
  zip_url: http://example.com/download.zip
  another_url: 另一个值
```
当你的网站构建时，Jekyll 将使用你指定的 URL，而不是 GitHub 提供的默认 URL。

注意：你必须删除 site. 前缀，并且每个变量名（在 github. 之后）应该在 github: 下面缩进两个空格。

更多信息，请参阅 Jekyll 变量文档。

路线图

查看未解决的问题以获取提议功能（和已知问题）的列表。

项目理念

Cayman 主题旨在让 GitHub Pages 用户快速轻松地创建他们的第一个（或第 100 个）网站。该主题应该能满足大多数用户的需求，倾向于简单而非灵活，并为用户提供机会选择增加复杂性，以满足他们的特定需求或进一步自定义他们的体验（如添加自定义 CSS 或修改默认布局）。它还应该看起来很棒，但这是不言而喻的。

贡献

有兴趣为 Cayman 做贡献吗？我们很乐意得到你的帮助。Cayman 是一个开源项目，由像你这样的用户一次一个贡献而构建。参见 CONTRIBUTING 文件以了解如何贡献的说明。

在本地预览主题

如果你想在本地预览主题（例如，在提出更改的过程中）：

克隆主题的仓库（git clone https://github.com/pages-themes/cayman）
cd 进入主题目录
运行 script/bootstrap 安装必要的依赖
运行 bundle exec jekyll serve 启动预览服务器
在浏览器中访问 localhost:4000 预览主题

运行测试

主题包含一个最小的测试套件，以确保使用该主题的网站能够成功构建。要运行测试，只需运行 script/cibuild。你需要在测试脚本工作之前运行一次 script/bootstrap。