Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix skin paths in README #357

Merged
merged 2 commits into from
Nov 13, 2019
Merged

Fix skin paths in README #357

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d105e95
fix extension names of skins
alxddh Nov 13, 2019
08af618
Fix
alxddh Nov 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,19 +338,19 @@ Configuration of site-wide elements (`locale`, `title`, `description`, `url`, `l

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

| `default.css` | `light.css` | `dark.css` |
| `default.scss` | `light.scss` | `dark.scss` |
| --- | --- | --- |
| ![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"
skin: "/assets/css/skins/default.scss"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the skin paths need to stay .css since those are the paths that will be added to the head, and HTML can’t read SCSS files.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! It's my fault. Yes, the skin paths need to stay in .css, but the link to /assets/css/skins/default.css needs to be modified to /assets/css/skins/default.scss.

skin: "/assets/css/skins/light.scss"
skin: "/assets/css/skins/dark.scss"
```

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.
1. Copy and rename [`/assets/css/skins/default.scss`](https://github.com/mmistakes/so-simple-theme/blob/master/assets/css/skins/default.scss) 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.

Expand Down