README.md in jekyll-theme-hamilton-3.1.0 vs README.md in jekyll-theme-hamilton-4.0.0
- old
+ new
@@ -4,13 +4,15 @@
The original purpose of this theme is to be a replacement of the default Jekyll theme -- [Minima](https://github.com/jekyll/minima). Hamilton is an enhancement of Minima but still, keep in minimal.
Please check out the [demo](https://ngzhio.github.io/jekyll-theme-hamilton/).
-| Daylight | Sunrise/Sunset | Midnight |
-| --- | --- | --- |
-| ![screenshot](screenshot.png) | ![screenshot](screenshot-sunrise.png) | ![screenshot](screenshot-midnight.png)
+| Skins | Displays |
+| ----- | -------- |
+| Daylight | ![screenshot](screenshot.png) |
+| Sunrise/Sunset | ![screenshot](screenshot-sunrise.png) |
+| Midnight | ![screenshot](screenshot-midnight.png) |
## Features <!-- omit in toc -->
- [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag)
- [Jekyll Feed](https://github.com/jekyll/jekyll-feed)
@@ -60,11 +62,11 @@
```yml
plugins:
- jekyll-remote-theme
- remote-theme: ngzhio/jekyll-theme-hamilton
+ remote_theme: ngzhio/jekyll-theme-hamilton
```
## Configuration
After installation, you can run `jekyll serve` to check out your site, but before that, *make sure* the below **required parameters** are configured in your `_config.yml`.
@@ -80,9 +82,10 @@
| Parameters | Types | Specifications |
|:---------- |:----- |:-------------- |
| `author` | string | The name of the author of the site; It would be showed in the copyright statement. |
| `avatar` | string | The avatar of the author of the site. |
| `email` | string | The email of the author of the site. |
+| `location` | string | The current living location of the author of the site. |
| `skin` | string | The skin name. See more information on the [Customization](#customization) section. |
| `lang` | string | The language of the site; The default value is `en`. |
| `paginate` | int | The number of posts on each page. |
| `date_format` | string | The date format; The default value is `%b %-d, %Y`. |