Skip to content

Commit ead6484

Browse files
committed
Use github-pages gem
This helps maintain a Jekyll build environment that matches the GH Pages build environment. Tested locally with Jekyll 4.4.1 (version requirement remains commented out in Gemfile). Docs: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll "github-pages" version 232 in Gemfile per https://pages.github.com/versions.json
1 parent c59dbe4 commit ead6484

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

Gemfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ source "https://rubygems.org"
77
#
88
# This will help ensure the proper Jekyll version is running.
99
# Happy Jekylling!
10-
# gem "jekyll", "~> 4.2.0"
10+
# gem "jekyll", "~> 4.4"
1111
# This is the default theme for new Jekyll sites. You may change this to anything you like.
1212
gem "minima", "~> 2.5"
1313
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
1414
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15-
# gem "github-pages", group: :jekyll_plugins
15+
gem "github-pages", "~> 232", group: :jekyll_plugins
1616
# If you have any plugins, put them here!
1717
group :jekyll_plugins do
1818
gem "jekyll-feed", "~> 0.12"

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ W3C Web Machine Learning Working Group and Community Group website.
55
## Environment Setup
66

77
```
8-
gem install bundler jekyll
8+
gem install bundler jekyll github-pages
99
```
1010

1111
## Run
@@ -16,6 +16,14 @@ bundle exec jekyll serve
1616
Server address: http://127.0.0.1:4000/
1717
```
1818

19+
## Update Jekyll and Dependencies
20+
21+
The [GitHub Pages gem](https://github.com/github/pages-gem) (`github-pages`) helps maintain a Jekyll build environment that most closely matches the GitHub Pages build environment. To update Jekyll and its dependencies:
22+
23+
```
24+
bundle update github-pages
25+
```
26+
1927
## Contributing
2028

2129
We welcome contributions! Please see the [contributing guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)