From 1ca7a00d37bf061eb390a0853b64aa8eddbfca95 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Wed, 15 Nov 2017 09:50:15 -0500 Subject: [PATCH] Add beta note about jekyll-remote-theme --- README.md | 2 ++ docs/_docs/01-quick-start-guide.md | 9 +++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20a7c9da..79202132 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,8 @@ To update the theme run `bundle update`. - 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 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/). diff --git a/docs/_docs/01-quick-start-guide.md b/docs/_docs/01-quick-start-guide.md index e5f84d9a..ab2d2c21 100644 --- a/docs/_docs/01-quick-start-guide.md +++ b/docs/_docs/01-quick-start-guide.md @@ -2,7 +2,7 @@ title: "Quick-Start Guide" permalink: /docs/quick-start-guide/ 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: - /theme-setup/ toc: true @@ -41,7 +41,10 @@ bundle install ### 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: @@ -61,6 +64,8 @@ plugins: - jekyll-remote-theme ``` +--- + **Note:** Your Jekyll site should be viewable immediately at . If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details). {: .notice--warning}