Skip to content

Commit bea6859

Browse files
committed
Improve remote theme upgrading documentation
1 parent 3eeba5f commit bea6859

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1212
- Display 'Posts' header only if the site has posts. [#144](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/144)
1313

1414
## Changed
15-
- Simplified image assigns.
15+
- Improve remote theme upgrading documentation.
16+
- Simplify image assigns.
1617
### Fixed
1718
- Fix to use current `bundle info` syntax. [#127](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/127)
1819
- Add `relative_url` filter to author profile image. [#125](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/125)

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ for any GitHub-hosted theme.
6666

6767
2. Run `bundle update` and verify that all gems install properly.
6868

69-
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your
69+
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic@1.4.4"` to your
7070
`_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
7171

7272
---
@@ -125,11 +125,17 @@ update jekyll-theme-basically-basic` if you're not.
125125

126126
### Remote Theme
127127

128-
When hosting with GitHub Pages you'll need to push up a commit to force a
129-
rebuild with the latest [theme release](https://github.com/mmistakes/jekyll-theme-basically-basic/releases).
128+
Verify you have the [latest version](https://github.com/mmistakes/jekyll-theme-basically-basic/releases) assigned in `_config.yml`
130129

131-
An empty commit will get the job done too if you don't have anything to push at
132-
the moment:
130+
```
131+
remote_theme: "mmistakes/[email protected]"
132+
```
133+
134+
Note: If `@x.x.x` is omitted the theme's current `master` branch will be used. It is advised to ["lock" `remote_theme`](https://github.com/benbalter/jekyll-remote-theme#declaring-your-theme) at a specific version to avoid introducing breaking changes to your site.
135+
136+
The next step requires rebuilding your [GitHub Pages](https://pages.github.com/) site so it can pull down the latest theme updates. This can be achieved by pushing up a commit to your GitHub repo.
137+
138+
An empty commit will get the job done too if you don't have anything to push at the moment:
133139

134140
```terminal
135141
git commit --allow-empty -m "Force rebuild of site"

0 commit comments

Comments
 (0)