Cayman是GitHub页主题. 你可以 预览主题样式, 或者直接 使用该主题样式.
如何使用Cayman主题样式:
-
添加以下内容到你的站配置文件
_config.yml
:theme: jekyll-theme-cayman
-
自己喜欢, 如果你想在自己计算机上预览主题样式效果, 添加以下内容到你的站配置文件
Gemfile
:gem "github-pages", group: :jekyll_plugins
如果要设置你的站配置文件 _config.yml
,Cayman主题将支持以下配置变量 :
title: [The title of your site]
description: [A short description of your site's purpose]
此外,你可以选择性配置以下可选配置变量:
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]
如果你想添加你的自定义样式的话,按以下步骤进行:
- 在你的站创建一个名为
/assets/css/style.scss
的文件 - 添加以下内容到文件顶部,如下所示:
--- --- @import "{{ site.theme }}";
- 紧接把你想要的自定义的CSS (或 Sass, 包括 imports) 添加到
@import
该行后面
如果你想改变主题的HTML布局的话,按以下步骤进行:
- 从主题的repository中拷贝源模板
(提示: 点击"raw" 更易拷贝) - 在你的站创建一个名为
/_layouts/default.html
的文件 - 第一步是粘贴默认布局的拷贝内容
- 自定义你想要的布局
阅读 开源组织 以了解主题的相关特性 .
Cayman主题意在帮助GitHub Pages用户简易快速建立自己的第一(百)个网站。 该主题主要迎合大多数用户的需要,让用户跳出框架,以简单化替代复杂化。同时,提供用户额外完全可选的机会以让他们实现一些特殊需求或更加灵活的自定义想要的主题(如天津自定义CSS或修改默认布局)。这看起是个很不错的主题,应该是无可厚非的。
有兴趣为Cayman主题贡献一份吗? 我们很希望你的帮忙。Cayman是一个开源项目,每次的贡献者都是像你这样的人。阅读 贡献文档 让你知道如何把你的贡献分享出来。
如果你想在本地预览主题 (例如, 在修改的过程中),按以下步骤进行:
- 克隆下载主题的repository (
git clone https://github.com/pages-themes/cayman
) cd
到主题的当前路径- 运行
script/bootstrap
来安装必要的依赖 - 运行
bundle exec jekyll serve
开始预览服务器 - 浏览器通过
localhost:4000
端口预览主题
该主题包含一个最小的测试套件,可以判断使用该主题的站是否搭建成功。运行script/cibuild
,获取测试结果。在脚本测试之前,你需要运行 script/bootstrap
一次,不然脚本测试不工作。