From e50ec22b31a91ed2beb79e6e086b276ac40b42cf Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Mon, 26 Jul 2021 16:56:19 -0400 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8fa0e07..29346fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # The Dinky theme -[Build Status](https://github.com/pages-themes/dinky/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-dinky.svg)](https://badge.fury.io/rb/jekyll-theme-dinky) +[![.github/workflows/ci.yaml](https://github.com/pages-themes/dinky/actions/workflows/ci.yaml/badge.svg)](https://github.com/pages-themes/dinky/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-dinky.svg)](https://badge.fury.io/rb/jekyll-theme-dinky) *Dinky is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/dinky), or even [use it today](#usage).* @@ -13,7 +13,9 @@ To use the Dinky theme: 1. Add the following to your site's `_config.yml`: ```yml - theme: jekyll-theme-dinky + remote_theme: pages-themes/dinky@v0.2.0 + plugins: + - jekyll-remote-theme # add this line to the plugins list if you already have one ``` 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] Additionally, you may choose to set the following optional variables: ```yml -show_downloads: ["true" or "false" to indicate whether to provide a download URL] +show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL] google_analytics: [Your Google Analytics tracking ID] ``` @@ -60,10 +62,15 @@ If you'd like to add your own custom styles: If you'd like to change the theme's HTML layout: -1. [Copy the original template](https://github.com/pages-themes/dinky/blob/master/_layouts/default.html) from the theme's repository
(*Pro-tip: click "raw" to make copying easier*) -2. Create a file called `/_layouts/default.html` in your site -3. Paste the default layout content copied in the first step -4. Customize the layout as you'd like +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/dinky/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/dinky/blob/master/_layouts/default.html). +2. For more extensive changes, [copy the original template](https://github.com/pages-themes/dinky/blob/master/_layouts/default.html) from the theme's repository
(*Pro-tip: click "raw" to make copying easier*) +3. Create a file called `/_layouts/default.html` in your site +4. Paste the default layout content copied in the first step +5. Customize the layout as you'd like + +### Customizing Google Analytics code + +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. ### Overriding GitHub-generated URLs @@ -106,4 +113,4 @@ If you'd like to preview the theme locally (for example, in the process of propo ### Running tests -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. +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.