Skip to content

Commit 906d4da

Browse files
committed
Update README.md
1 parent a5aafee commit 906d4da

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The Slate theme
22

3-
[Build Status](https://github.com/pages-themes/slate/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-slate.svg)](https://badge.fury.io/rb/jekyll-theme-slate)
3+
[![.github/workflows/ci.yaml](https://github.com/pages-themes/slate/actions/workflows/ci.yaml/badge.svg)](https://github.com/pages-themes/slate/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-slate.svg)](https://badge.fury.io/rb/jekyll-theme-slate)
44

55
*Slate is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/slate), or even [use it today](#usage).*
66

@@ -13,7 +13,9 @@ To use the Slate theme:
1313
1. Add the following to your site's `_config.yml`:
1414

1515
```yml
16-
theme: jekyll-theme-slate
16+
remote_theme: pages-themes/[email protected]
17+
plugins:
18+
- jekyll-remote-theme # add this line to the plugins list if you already have one
1719
```
1820
1921
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
@@ -36,7 +38,7 @@ description: [A short description of your site's purpose]
3638
Additionally, you may choose to set the following optional variables:
3739

3840
```yml
39-
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
41+
show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
4042
google_analytics: [Your Google Analytics tracking ID]
4143
```
4244

@@ -60,10 +62,15 @@ If you'd like to add your own custom styles:
6062

6163
If you'd like to change the theme's HTML layout:
6264

63-
1. [Copy the original template](https://github.com/pages-themes/slate/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
64-
2. Create a file called `/_layouts/default.html` in your site
65-
3. Paste the default layout content copied in the first step
66-
4. Customize the layout as you'd like
65+
1. For some changes such as a custom `favicon`, you can add custom files in your local `_includes` folder. The files [provided with the theme](https://github.com/pages-themes/slate/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/slate/blob/master/_layouts/default.html).
66+
2. For more extensive changes, [copy the original template](https://github.com/pages-themes/slate/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
67+
3. Create a file called `/_layouts/default.html` in your site
68+
4. Paste the default layout content copied in the first step
69+
5. Customize the layout as you'd like
70+
71+
### Customizing Google Analytics code
72+
73+
Google 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.
6774

6875
### Overriding GitHub-generated URLs
6976

@@ -106,4 +113,4 @@ If you'd like to preview the theme locally (for example, in the process of propo
106113

107114
### Running tests
108115

109-
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.
116+
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.

0 commit comments

Comments
 (0)