Add the following to your site's _config.yml
:
theme: jekyll-design
The jekyll-design will respect the following variables, if set in your site's _config.yml
:
title: [The title of your site]
description: [A short description of your site's purpose]
Additionally, you may choose to set the following optional variables:
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]
If you'd like to add your own custom styles:
/assets/css/style.scss
in your site---
---
@import "{{ site.theme }}";
@import
lineNote: If you'd like to change the theme's Sass variables, you must set new values before the @import
line in your stylesheet.
If you'd like to change the theme's HTML layout:
/_layouts/default.html
in your siteTemplates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs:
{{ site.github.zip_url }}
._config.yml
. For example, if the variable was site.github.url
, you'd add the following:github:
zip_url: http://example.com/download.zip
another_url: another value
Note: You must remove the site.
prefix, and each variable name (after the github.
) should be indent with two space below github:
.
For more information, see the Jekyll variables documentation.
See the ...
The jekyll-design is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
Interested in contributing to jekyll-design? We'd love your help. jekyll-design is an open source project, built one contribution at a time by users like you. See the CONTRIBUTING file for instructions on how to contribute.