From e0579ca495c23d44f1d140cc10a303d661ca8316 Mon Sep 17 00:00:00 2001
From: Pat Dryburgh <hello@patdryburgh.com>
Date: Thu, 1 Oct 2020 13:42:29 -0700
Subject: [PATCH] update to Jekyll ~> 4.0
---
.gitignore | 3 ++-
README.md | 23 ++++++++++++-------
...er-blaze.md => 2018-08-11-silver-blaze.md} | 0
...dventure-of-charles-augustus-milverton.md} | 0
...l-posts.md => 2018-08-12-not-all-posts.md} | 0
hitchens-theme.gemspec | 6 ++---
6 files changed, 20 insertions(+), 12 deletions(-)
rename _posts/{2018-08-12-silver-blaze.md => 2018-08-11-silver-blaze.md} (100%)
rename _posts/{2018-08-12-the-adventure-of-charles-augustus-milverton.md => 2018-08-11-the-adventure-of-charles-augustus-milverton.md} (100%)
rename _posts/{2018-07-24-not-all-posts.md => 2018-08-12-not-all-posts.md} (100%)
diff --git a/.gitignore b/.gitignore
index 867d3792d..086b32046 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
*.gem
.bundle
.sass-cache
+.jekyll-cache
_site
-Gemfile.lock
+Gemfile.lock
\ No newline at end of file
diff --git a/README.md b/README.md
index 9efda027d..79b48683f 100644
--- a/README.md
+++ b/README.md
@@ -20,26 +20,33 @@ To get started quickly, follow the instructions below:
3. Scroll down to the `GitHub Pages` section;
4. Under `Source`, select the `Master` branch;
5. Hit `Save`.
+6. Follow [Jekyll's instructions to configure your new Jekyll site](https://jekyllrb.com/docs/configuration/).
## Manual Installation
-If you're comfortable in the command line, add this line to your Jekyll site's `Gemfile`:
+If you've already created your Jekyll site or are comfortable with the command line, you can follow [Jekyll's Quickstart instructions](https://jekyllrb.com/docs/) add this line to your Jekyll site's `Gemfile`:
```ruby
gem "hitchens-theme"
```
-And add this line to your Jekyll site's `_config.yml`:
+And add the following lines to your Jekyll site's `_config.yml`:
```yaml
theme: hitchens-theme
```
-And then execute:
+Depending on your [site's configuration](https://jekyllrb.com/docs/configuration/options/), you may also need to add:
+
+```yaml
+ignore_theme_config: true
+```
+
+And then on the command line, execute:
$ bundle
-Or install it yourself as:
+Or install the theme yourself as:
$ gem install hitchens-theme
@@ -47,13 +54,13 @@ Or install it yourself as:
### Home Layout
-The `home` layout presents a list of articles ordered chronologically. All articles are presented in one page, similar to a book's table of contents.
+The `home` layout presents a list of articles ordered chronologically. The theme uses [Jekyll's built-in pagination](https://jekyllrb.com/docs/pagination/#enable-pagination) which can be configured in your `_config.yml` file.
The masthead of the home page is derived from the `title` and `description` set in your site's `_config.yml` file.
#### Navigation
-To include navigation in your site's masthead:
+To include a navigation menu in your site's masthead and footer:
1. Create a `_data` directory in the root of your site.
2. Add a `menu.yml` file to the `_data` directory.
@@ -154,7 +161,7 @@ hide_credits: true
### Search
-The theme uses a [custom DuckDuckGo Search Form](https://patdryburgh.com/blog/adding-a-custom-duckduckgo-search-bar-to-your-site/) that can be turned off by including the following line in your site's `_config.yml` file:
+The theme uses a [custom DuckDuckGo Search Form](https://ddg.patdryburgh.com) that can be turned off by including the following line in your site's `_config.yml` file:
```
hide_search: true
@@ -182,7 +189,7 @@ The theme is setup just like a normal Jekyll site. To test the theme, run `bundl
## License
-The code for this theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The code for this theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
The font, EB Garamond, is Copyright 2017 The EB Garamond Project Authors and licensed under the [SIL Open Font License Version 1.1](https://github.com/patdryburgh/hitchens/blob/master/assets/fonts/OFL.txt).
diff --git a/_posts/2018-08-12-silver-blaze.md b/_posts/2018-08-11-silver-blaze.md
similarity index 100%
rename from _posts/2018-08-12-silver-blaze.md
rename to _posts/2018-08-11-silver-blaze.md
diff --git a/_posts/2018-08-12-the-adventure-of-charles-augustus-milverton.md b/_posts/2018-08-11-the-adventure-of-charles-augustus-milverton.md
similarity index 100%
rename from _posts/2018-08-12-the-adventure-of-charles-augustus-milverton.md
rename to _posts/2018-08-11-the-adventure-of-charles-augustus-milverton.md
diff --git a/_posts/2018-07-24-not-all-posts.md b/_posts/2018-08-12-not-all-posts.md
similarity index 100%
rename from _posts/2018-07-24-not-all-posts.md
rename to _posts/2018-08-12-not-all-posts.md
diff --git a/hitchens-theme.gemspec b/hitchens-theme.gemspec
index 27d0e4bf5..68976dc47 100644
--- a/hitchens-theme.gemspec
+++ b/hitchens-theme.gemspec
@@ -2,7 +2,7 @@
Gem::Specification.new do |spec|
spec.name = "hitchens-theme"
- spec.version = "0.7.2"
+ spec.version = "0.8.0"
spec.authors = ["Pat Dryburgh"]
spec.email = ["hello@patdryburgh.com"]
@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r!^(assets|_layouts|_includes|_sass|LICENSE|README)!i) }
- spec.add_runtime_dependency "jekyll", "~> 3.8"
+ spec.add_runtime_dependency "jekyll", "~> 4.0"
- spec.add_development_dependency "bundler", "~> 1.17"
+ spec.add_development_dependency "bundler", "~> 2.1"
spec.add_development_dependency "rake", "~> 12.0"
end