Minimal 是 GitHub Pages 的 Jekyll 主题。您可以预览主题以查看它的外观,甚至可以立即使用它。
要使用最小主题:
将以下内容添加到您站点的_config.yml
:
remote_theme : pages-themes/[email protected]
plugins :
- jekyll-remote-theme # add this line to the plugins list if you already have one
或者,如果您想在计算机上预览站点,请将以下内容添加到站点的Gemfile
中:
gem "github-pages" , group : :jekyll_plugins
如果在站点的_config.yml
中设置,Minimal 将遵循以下变量:
title : [The title of your site]
description : [A short description of your site's purpose]
此外,您可以选择设置以下可选变量:
show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]
如果您想添加自己的自定义样式:
/assets/css/style.scss
的文件---
---
@import " {{ site.theme }} " ;
@import
行之后立即添加您想要的任何自定义 CSS(或 Sass,包括导入)注意:如果您想更改主题的 Sass 变量,则必须在样式表中的@import
行之前设置新值。
如果您想更改主题的 HTML 布局:
favicon
,您可以在本地_includes
文件夹中添加自定义文件。随主题提供的文件提供了一个起点,并包含在原始布局模板中。/_layouts/default.html
的文件自该主题首次创建以来,多年来 Google 已经发布了 Google Analytics 代码的多次迭代。如果您想利用最新代码,请将其粘贴到 Jekyll 站点的_includes/head-custom-google-analytics.html
中。
模板通常依赖于 GitHub 提供的 URL,例如存储库的链接或下载项目的链接。如果您想覆盖一个或多个默认 URL:
{{ site.github.zip_url }}
的形式。_config.yml
中使用的 URL。例如,如果变量是site.github.url
,您需要添加以下内容: github :
zip_url : http://example.com/download.zip
another_url : another value
注意:您必须删除该site.
前缀,每个变量名(在github.
之后)应该在github:
下面缩进两个空格。
有关更多信息,请参阅 Jekyll 变量文档。
请参阅未决问题以获取建议功能(和已知问题)的列表。
Minimal 主题旨在让 GitHub Pages 用户快速轻松地创建他们的第一个(或第 100 个)网站。主题应满足绝大多数用户的开箱即用需求,宁可简单化,而不要灵活,并为用户提供选择额外复杂性的机会(如果他们有特定需求或希望进一步定制其体验) (例如添加自定义 CSS 或修改默认布局)。它看起来也应该很棒,但这是不言而喻的。
有兴趣为 Minimal 做出贡献吗?我们希望得到您的帮助。 Minimal 是一个开源项目,由像您这样的用户一次构建一个贡献。有关如何贡献的说明,请参阅贡献文件。
如果您想在本地预览主题(例如,在提出更改建议的过程中):
git clone https://github.com/pages-themes/minimal
)cd
进入主题目录script/bootstrap
以安装必要的依赖项bundle exec jekyll serve
来启动预览服务器localhost:4000
预览主题该主题包含一个最小的测试套件,以确保具有该主题的网站能够成功构建。要运行测试,只需运行script/cibuild
。在测试脚本运行之前,您需要运行script/bootstrap
一次。