Slate

Theme by Pages themes

|

Updated: 16 Jan 2024

|

313 Stars

Slate is a Jekyll theme for GitHub Pages

Overview:

The Slate theme is a Jekyll theme designed specifically for GitHub Pages. It aims to provide users with a quick and simple way to create websites on GitHub Pages. The theme offers a default layout and styling that can be easily customized to meet the user’s preferences. It also allows users to add their own custom CSS styles and override certain default URLs generated by GitHub.

Features:

• Easy Setup: The Slate theme can be added to a GitHub Pages site by simply adding a few lines of code to the site’s _config.yml file.
• Customization: Users can customize the theme by modifying configuration variables in the _config.yml file, such as site title, description, and social media links.
• Custom Styling: The theme allows users to add their own custom CSS styles by creating a style.scss file and adding the desired styles.
• Layout Customization: Users can change the theme’s HTML layout by creating a default.html file in the _layouts folder and customizing the layout as needed.
• Google Analytics Integration: The theme provides a convenient way to add Google Analytics code to the site by pasting it into the head-custom-google-analytics.html file.
• URL Override: Users can override default URLs generated by GitHub, such as links to the repository or project download, by specifying the desired URL in the _config.yml file.

Installation:

To use the Slate theme on a GitHub Pages site, follow these steps:

1. Add the following code to the site’s _config.yml file:

theme: jekyll-theme-slate

2. (Optional) If you want to preview the site on your computer, add the following code to the site’s Gemfile:

gem "github-pages", group: :jekyll_plugins

3. Customize the theme by setting desired variables in the _config.yml file, such as site title, description, and social media links.

4. (Optional) If you want to add custom CSS styles, create a style.scss file in the /assets/css/ folder and add your styles to it.

5. (Optional) If you want to customize the theme’s HTML layout, create a default.html file in the _layouts/ folder and customize the layout as needed.

6. (Optional) If you want to add Google Analytics code, paste it into the head-custom-google-analytics.html file in your Jekyll site.

7. (Optional) If you want to override default GitHub-generated URLs, specify the desired URL in the _config.yml file using the appropriate variable name.

Summary:

The Slate theme is a Jekyll theme specifically designed for GitHub Pages. It offers an easy and quick way for users to create websites on GitHub Pages. The theme provides default layout and styling, which can be easily customized to meet the user’s preferences. Users can also add their own custom CSS styles and override certain default URLs generated by GitHub. With its simplicity and flexibility, the Slate theme aims to meet the needs of most GitHub Pages users while allowing for customization when required.