cayman

cayman

GitHub Pages专用Jekyll主题 快速构建简洁网站

Cayman是为GitHub Pages设计的Jekyll主题,特点是配置简单、风格清晰。主题支持自定义样式和布局,适合各层级用户使用。它注重易用性,能满足大多数网站需求,同时保留了深度定制的可能。Cayman主题致力于帮助用户快速搭建网站,并在此基础上提供进阶的个性化选项。

CaymanJekyll主题GitHub Pages网站定制开源项目Github

Cayman 主题

.github/workflows/ci.yaml Gem 版本

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

Cayman 缩略图

使用方法

要使用 Cayman 主题:

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

    remote_theme: pages-themes/cayman@v0.2.0 plugins: - jekyll-remote-theme # 如果你已经有插件列表,请将此行添加到列表中
  2. 如果你想在电脑上预览你的网站,可以选择在网站的 Gemfile 中添加以下内容:

    gem "github-pages", group: :jekyll_plugins

自定义

配置变量

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

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

此外,你可以选择设置以下可选变量:

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

样式表

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

  1. 在你的网站中创建一个名为 /assets/css/style.scss 的文件
  2. 在文件顶部添加以下内容,确保内容完全一致:
    --- --- @import "{{ site.theme }}";
  3. @import 行之后立即添加任何自定义 CSS(或 Sass,包括导入)

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

布局

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

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

自定义 Google Analytics 代码

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

覆盖 GitHub 生成的 URL

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

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

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

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

路线图

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

项目理念

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

贡献

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

在本地预览主题

如果你想在本地预览主题(例如,在提出更改的过程中):

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

运行测试

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

编辑推荐精选

博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌,基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构,帮助企业扫清合规障碍,筑牢风控防线,成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案,助力品牌曝光

稳定高效的流量提升解决方案,助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用,一键生成无水印视频

最新版Sora2模型免费使用,一键生成无水印视频

Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
商汤小浣熊

商汤小浣熊

最强AI数据分析助手

小浣熊家族Raccoon,您的AI智能助手,致力于通过先进的人工智能技术,为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答,小浣熊都能以快速、准确的响应满足您的需求,让您的生活更加智能便捷。

imini AI

imini AI

像人一样思考的AI智能体

imini 是一款超级AI智能体,能根据人类指令,自主思考、自主完成、并且交付结果的AI智能体。

下拉加载更多