Skip to content

Commit

Permalink
docs: update instructions for remote theme
Browse files Browse the repository at this point in the history
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`).
  • Loading branch information
jeffreytse committed Dec 20, 2024
1 parent 5f85d8c commit 8524995
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -143,14 +143,18 @@ 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`:

```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:
Expand Down

0 comments on commit 8524995

Please sign in to comment.