From 85249954743ea2ba283a65b9b08e18eb27016dcb Mon Sep 17 00:00:00 2001 From: Jeffrey Tse Date: Fri, 20 Dec 2024 10:37:38 +0800 Subject: [PATCH] docs: update instructions for remote theme Update instructions for remote theme setup, as `github-pages` gem is required for old versions of jekyll 3.10.0 (which is `< 4.0.0`). --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5754a1d2ceb..837689d9ca2 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,7 @@ Or install it yourself as: $ gem install jekyll-theme-yat ``` -### Remote Theme Method with GitHub Pages +### Remote Theme Method with Jekyll Remote Theme Plugin Remote themes are similar to Gem-based themes, but do not require `Gemfile` changes or whitelisting making them ideal for sites hosted with GitHub Pages. @@ -143,7 +143,7 @@ To install: Add this line to your Jekyll site's `Gemfile`: ```ruby -gem "github-pages", group: :jekyll_plugins +gem "jekyll-remote-theme", group: :jekyll_plugins ``` And add this line to your Jekyll site's `_config.yml`: @@ -151,6 +151,10 @@ And add this line to your Jekyll site's `_config.yml`: ```yaml # theme: owner/name --> Don't forget to remove/comment the gem-based theme option remote_theme: "jeffreytse/jekyll-theme-yat" + +# Add the following to activate the plugin +plugins: + - jekyll-remote-theme ``` And then execute: