Skip to content

Commit

Permalink
Merge pull request #350 from mmistakes/3.2.0
Browse files Browse the repository at this point in the history
## Added
- Add light and dark skins. [#347]
- Add support for customizable skins. [#347]

## Fixed
- Fix security alerts and update [onchange](https://www.npmjs.com/package/onchange) development dependency in `package.json`. [#341]
  • Loading branch information
mmistakes authored Oct 30, 2019
2 parents 8d7015d + 4131bfb commit e37376e
Show file tree
Hide file tree
Showing 13 changed files with 48 additions and 23 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
## [3.2.0] - 10-29-2019

### Added
- Add light and dark skins. [#347](https://github.com/mmistakes/so-simple-theme/pull/347)
- Add support for customizable skins. [#347](https://github.com/mmistakes/so-simple-theme/pull/347)

### Fixed
- Fix security alerts and update [onchange](https://www.npmjs.com/package/onchange) development dependency in `package.json`. [#341](https://github.com/mmistakes/so-simple-theme/issues/341)
Expand Down
47 changes: 34 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,20 @@ Additional [sample posts](https://mmistakes.github.io/so-simple-theme/posts/) ca
1. [Starting Fresh](#starting-fresh)
2. [Starting from `jekyll new`](#starting-from-jekyll-new)
4. [Configuring](#configuring)
1. [Site Locale](#site-locale)
2. [Site URL](#site-url)
3. [Site Base URL](#site-base-url)
4. [Date Format](#date-format)
5. [Reading Time](#reading-time)
6. [Mathematics](#mathematics)
7. [Google Fonts](#google-fonts)
8. [Pagination](#pagination)
9. [Search](#search)
10. [Taxonomy Pages](#taxonomy-pages)
11. [Comments (via Disqus)](#comments-via-disqus)
12. [Google Analytics](#google-analytics)
13. [Other](#other)
1. [Site Skin](#site-skin)
2. [Site Locale](#site-locale)
3. [Site URL](#site-url)
4. [Site Base URL](#site-base-url)
5. [Date Format](#date-format)
6. [Reading Time](#reading-time)
7. [Mathematics](#mathematics)
8. [Google Fonts](#google-fonts)
9. [Pagination](#pagination)
10. [Search](#search)
11. [Taxonomy Pages](#taxonomy-pages)
12. [Comments (via Disqus)](#comments-via-disqus)
13. [Google Analytics](#google-analytics)
14. [Other](#other)
5. [Layouts](#layouts)
1. [`layout: default`](#layout-default)
2. [`layout: post`](#layout-post)
Expand Down Expand Up @@ -325,6 +326,26 @@ Configuration of site-wide elements (`locale`, `title`, `description`, `url`, `l
| `url` | The full URL to your site. | `"https://your-site.com"` |
| `logo` | Path to a site-wide logo used in masthead. | `/images/your-logo.png` |

### Site Skin

Three skins (default, light, and dark) are available to change the color palette of the theme.

| `default.css` | `light.css` | `dark.css` |
| --- | --- | --- |
| ![default skin](https://mmistakes.github.io/so-simple-theme/images/default-skin.png) | ![light skin](https://mmistakes.github.io/so-simple-theme/images/light-skin.png) | ![dark skin](https://mmistakes.github.io/so-simple-theme/images/dark-skin.png) |

```yaml
skin: "/assets/css/skins/default.css"
skin: "/assets/css/skins/light.css"
skin: "/assets/css/skins/dark.css"
```
To use a custom skin other than the ones provided:
1. Copy and rename [`/assets/css/skins/default.css`](https://github.com/mmistakes/so-simple-theme/blob/master/assets/css/skins/default.css) to your local repo.
2. Override and customize Sass variables as you see fit.
3. Update the `skin` path in `_config.yml` to reference this new skin `.css` file.

### Site Locale

**`site.locale`** is used to declare the primary language for each web page within the site.
Expand Down
3 changes: 1 addition & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
# in the templates via {{ site.myvariable }}.
theme: jekyll-theme-so-simple
# remote_theme: mmistakes/so-simple-theme
skin: "/assets/css/skins/default.css"
locale: en-US
title: "My Awesome Site"
description: "It really is the best."
Expand Down Expand Up @@ -101,5 +102,3 @@ footer_links:
- title: Feed
url: atom.xml
icon: fas fa-rss-square

skin: "/assets/css/skins/default.css"
2 changes: 1 addition & 1 deletion _layouts/default.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
So Simple Jekyll Theme 3.1.3
So Simple Jekyll Theme 3.2.0
Copyright 2013-2019 Michael Rose - mademistakes.com | @mmistakes
Free for personal and commercial use under the MIT license
https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion _sass/so-simple.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*!
* So Simple Jekyll Theme 3.1.3
* So Simple Jekyll Theme 3.2.0
* Copyright 2013-2019 Michael Rose - mademistakes.com | @mmistakes
* Free for personal and commercial use under the MIT license
* https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE
Expand Down
4 changes: 2 additions & 2 deletions assets/js/main.min.js

Large diffs are not rendered by default.

Binary file added docs/images/dark-skin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/default-skin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/light-skin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions example/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
# in the templates via {{ site.myvariable }}.
theme: jekyll-theme-so-simple
# remote_theme: mmistakes/so-simple-theme
skin: "/assets/css/skins/default.css"
locale: en-US
title: "So Simple Development Site"
description: "A simple Jekyll theme for words and pictures."
Expand Down
2 changes: 1 addition & 1 deletion jekyll-theme-so-simple.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Gem::Specification.new do |spec|
spec.name = "jekyll-theme-so-simple"
spec.version = "3.1.3"
spec.version = "3.2.0"
spec.authors = ["Michael Rose"]

spec.summary = %q{A simple Jekyll theme for words and pictures.}
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "jekyll-theme-so-simple",
"description": "A simple Jekyll theme for words and pictures.",
"version": "3.1.3",
"version": "3.2.0",
"author": "Michael Rose",
"homepage": "http://mmistakes.github.io/so-simple-theme/",
"repository": {
Expand Down

0 comments on commit e37376e

Please sign in to comment.