Update to Jekyll 4, add docs for Front Matter layout defaults

Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
 
-gem "webrick", "~> 1.7"
-gem "just-the-hm-docs", ">= 1.0.1.rc1"
+gem "jekyll", "~> 4.3.2"
+gem "webrick", "~> 1.8"
+gem "just-the-hm-docs", github: "humanmade/just-the-hm-docs"

_config.yml

@@ -6,7 +6,7 @@
 # feature for the data you need to update frequently.
 #
 # For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'jekyll serve'. If you change this file, please restart the server process.
+# "jekyll serve". If you change this file, please restart the server process.
 
 # Site settings
 # These are used to personalize your new site. If you look in the HTML files,
@@ -17,8 +17,8 @@ title: Just the HM Docs
 tagline: A Jekyll template for documenting Human Made open source projects
 description: A modern, highly customizable, responsive Jekyll template for documentation
 author: Human Made
-baseurl: '/just-the-hm-docs' # the subpath of your site, e.g. /blog
-url: 'https://humanmade.github.io' # the base hostname & protocol for your site, e.g. http://example.com
+baseurl: "/just-the-hm-docs" # the subpath of your site, e.g. /blog
+url: "https://humanmade.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 
 # Set a path/url to a logo that will be displayed instead of the title
 logo: "/assets/icons/hm-logo.svg"
@@ -99,10 +99,8 @@ heading_anchors: true
 
 # Aux links for the upper right navigation
 aux_links:
-  Human Made:
-    - 'https://humanmade.com'
   Just the HM Docs on GitHub:
-    - 'https://github.com/humanmade/just-the-hm-docs'
+    - "https://github.com/humanmade/just-the-hm-docs"
 
 # Makes Aux links open in a new tab. Default is false
 aux_links_new_tab: false

changelog.md

@@ -7,6 +7,13 @@ nav_order: 99
 
 # Changelog
 
+## v1.0.2
+
+- Update Jekyll version to 4.3.2
+- Update Webrick to 1.8
+- Add docs for setting Front Matter layout defaults
+- Use GitHub hosted theme
+
 ## v1.0.1
 
 - Fix Sass compiling bug

docs/customization.md

@@ -387,3 +387,16 @@ layout: default
 ```
 
 {% endraw %}
+
+### Defining a default layout
+
+To properly load a layout template with all of its includes and styles, you must define which layout you wish to use. Just the HM Docs does this by defining the layout in page front matter, as shown above. If you wish to set a default layout and not explicitly state the layout in each template, you must add the following Front Matter defaults to your `_config.yml` file:
+
+```
+defaults:
+  -
+    scope:
+      path: "" # an empty string here means all files in the project
+    values:
+      layout: "default"
+```

just-the-hm-docs.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "just-the-hm-docs"
-  spec.version       = "1.0.1.rc1"
+  spec.version       = "1.0.2.rc1"
   spec.authors       = ["Human Made"]
   spec.email         = ["[email protected]"]
 
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   << 'just-the-hm-docs'
 
   spec.add_development_dependency "bundler", "~> 2.3.5"
-  spec.add_runtime_dependency "jekyll", ">= 3.8.5"
+  spec.add_runtime_dependency "jekyll", ">= 4.3.2"
   spec.add_runtime_dependency "jekyll-seo-tag", ">= 2.0"
   spec.add_runtime_dependency "rake", ">= 12.3.1"
 end