This is a jekyll theme based on the Modernist theme.
NOTE: This fork contains code specific to the RoseSMP wiki. While we will try to make this work for everyone, some code will only work for our use case. Sorry for inconveniences. See all the changes we've made here
To use the Clean theme:
Add the following to your site's _config.yml
:
remote_theme: RoseSMP/wiki
plugins:
- jekyll-remote-theme
Clean 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]
show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]
favicon: [Path to your site's favicon]
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:
favicon
, you can add custom files in your local _includes
folder. The files provided with the theme provide a starting point and are included by the original layout template./_layouts/default.html
in your siteGoogle has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into _includes/head-custom-google-analytics.html
in your Jekyll site.
Templates 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.