ry
/
datat.fi
6
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Improve remote theme upgrading documentation

This commit is contained in:
Michael Rose 2021-07-05 21:08:32 -04:00
parent 3eeba5f250
commit bea6859399
2 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -12,7 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Display 'Posts' header only if the site has posts. [#144](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/144)
## Changed
- Simplified image assigns.
- Improve remote theme upgrading documentation.
- Simplify image assigns.
### Fixed
- Fix to use current `bundle info` syntax. [#127](https://github.com/mmistakes/jekyll-theme-basically-basic/pull/127)
- Add `relative_url` filter to author profile image. [#125](https://github.com/mmistakes/jekyll-theme-basically-basic/issues/125)

16
README.md
View File

@ -66,7 +66,7 @@ for any GitHub-hosted theme.
2. Run `bundle update` and verify that all gems install properly.
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your
3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic@1.4.4"` to your
`_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
---
@ -125,11 +125,17 @@ update jekyll-theme-basically-basic` if you're not.
### Remote Theme
When hosting with GitHub Pages you'll need to push up a commit to force a
rebuild with the latest [theme release](https://github.com/mmistakes/jekyll-theme-basically-basic/releases).
Verify you have the [latest version](https://github.com/mmistakes/jekyll-theme-basically-basic/releases) assigned in `_config.yml`
An empty commit will get the job done too if you don't have anything to push at
the moment:
```
remote_theme: "mmistakes/jekyll-theme-basically-basic@1.4.4"
```
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.
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.
An empty commit will get the job done too if you don't have anything to push at the moment:
```terminal
git commit --allow-empty -m "Force rebuild of site"