Add beta note about jekyll-remote-theme
This commit is contained in:
parent
a4fceb8ac1
commit
1ca7a00d37
|
@ -117,6 +117,8 @@ To update the theme run `bundle update`.
|
||||||
- jekyll-remote-theme
|
- jekyll-remote-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.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
For detailed instructions on how to configure, customize, add/migrate content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
|
For detailed instructions on how to configure, customize, add/migrate content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
title: "Quick-Start Guide"
|
title: "Quick-Start Guide"
|
||||||
permalink: /docs/quick-start-guide/
|
permalink: /docs/quick-start-guide/
|
||||||
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
|
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
|
||||||
last_modified_at: 2017-11-10T11:25:59-05:00
|
last_modified_at: 2017-11-15T09:49:52-05:00
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /theme-setup/
|
- /theme-setup/
|
||||||
toc: true
|
toc: true
|
||||||
|
@ -41,7 +41,10 @@ bundle install
|
||||||
|
|
||||||
### GitHub Pages Compatible Methods
|
### GitHub Pages Compatible Methods
|
||||||
|
|
||||||
If you're hosting with GitHub Pages follow these steps instead:
|
If you're hosting with GitHub Pages follow these steps instead.
|
||||||
|
|
||||||
|
**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:
|
Replace `gem "jekyll"` with:
|
||||||
|
|
||||||
|
@ -61,6 +64,8 @@ plugins:
|
||||||
- jekyll-remote-theme
|
- jekyll-remote-theme
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details).
|
**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details).
|
||||||
{: .notice--warning}
|
{: .notice--warning}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue