Skip to content

Commit 15f96bb

Browse files
MV10mmistakes
authored andcommittedJan 2, 2018
Remote plugin reference unnecessary for GitHub Pages (mmistakes#1439)
1 parent dcc85dd commit 15f96bb

File tree

1 file changed

+3
-22
lines changed

1 file changed

+3
-22
lines changed
 

‎docs/_docs/01-quick-start-guide.md

+3-22
Original file line numberDiff line numberDiff line change
@@ -39,30 +39,11 @@ Then run Bundler to install the theme gem and dependencies:
3939
bundle install
4040
```
4141

42-
### GitHub Pages Compatible Methods
42+
### GitHub Pages Method
4343

44-
If you're hosting with GitHub Pages follow these steps instead.
44+
GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages) for any GitHub-hosted theme.
4545

46-
**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.
47-
{: .notice--warning}
48-
49-
Replace `gem "jekyll"` with:
50-
51-
```
52-
gem "github-pages", group: :jekyll_plugins
53-
gem "jekyll-remote-theme"
54-
```
55-
56-
Run `bundle update` and verify that all gems install properly.
57-
58-
Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file.
59-
60-
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:
61-
62-
```
63-
plugins:
64-
- jekyll-remote-theme
65-
```
46+
Add `remote_theme: "mmistakes/minimal-mistakes"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
6647

6748
---
6849

0 commit comments

Comments
 (0)
Please sign in to comment.