N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Remote plugin reference unnecessary for GitHub Pages (#1439)

Browse source
This commit is contained in:
MV10 2018-01-02 16:13:07 -05:00 committed by Michael Rose
parent c69bf6ca8f
commit d95cfbc58e
1 changed files with 3 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/_docs/01-quick-start-guide.md
View file

@ -39,30 +39,11 @@ Then run Bundler to install the theme gem and dependencies:
bundle install
```
### GitHub Pages Compatible Methods
### GitHub Pages Method
If you're hosting with GitHub Pages follow these steps instead.
GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages) for any GitHub-hosted theme.
**Note:** [jekyll-remote-theme](https://github.com/benbalter/jekyll-remote-theme) is currently in beta on GitHub Pages. In my tests it works as advertised, with the occasional failure due to missing `_includes` and `_layouts` --- your results may vary.
{: .notice--warning}
Replace `gem "jekyll"` with:
```
gem "github-pages", group: :jekyll_plugins
gem "jekyll-remote-theme"
```
Run `bundle update` and verify that all gems install properly.
Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file.
Then add [`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme) to the `plugins` (previously gems) array in your `_config.yml` file like so:
```
plugins:
- jekyll-remote-theme
```
Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
---