diff --git a/docs/_docs/01-quick-start-guide.md b/docs/_docs/01-quick-start-guide.md index 646f654b0d51..4c5e24253def 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-10-20T12:34:04-04:00 +last_modified_at: 2017-11-07T20:48:04-05:00 redirect_from: - /theme-setup/ toc: true @@ -12,7 +12,7 @@ Minimal Mistakes has been developed as a [Jekyll theme gem](http://jekyllrb.com/ ## Installing the Theme -If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem. If you're hosting with GitHub Pages you'll have to use the old "repo fork" method or directly copy all of the theme files[^structure] into your site. +If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem. [^structure]: See [**Structure** page]({{ "/docs/structure/" | absolute_url }}) for a list of theme files and what they do. @@ -39,9 +39,29 @@ Then run Bundler to install the theme gem and dependencies: bundle install ``` -### GitHub Pages Compatible Method +### GitHub Pages Compatible Methods -Fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username. +If you're hosting with GitHub Pages follow these steps instead: + +Replace `gem "jekyll"` with: + +``` +gem "github-pages", group: :jekyll_plugins +gem "jekyll-remote-theme" +``` + +Then run `bundle update` and verify that all gems install properly. + +Finally add `jekyll-remote-theme` to the `plugins` (previously gems) array in your `_config.yml` file like so: + +``` +plugins: + - jekyll-remote-theme +``` + +You can also install the theme by forking or copying all of the theme files[^structure] into your site. + +To do so fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
fork Minimal Mistakes @@ -62,14 +82,6 @@ Replace the contents of `Gemfile` found in the root of your Jekyll site with the source "https://rubygems.org" gem "github-pages", group: :jekyll_plugins - -group :jekyll_plugins do - gem "jekyll-paginate" - gem "jekyll-sitemap" - gem "jekyll-gist" - gem "jekyll-feed" - gem "jemoji" -end ``` Then run `bundle update` and verify that all gems install properly. diff --git a/docs/_docs/03-installation.md b/docs/_docs/03-installation.md index 6a8cfeb0adb2..7b608f1aa6ae 100644 --- a/docs/_docs/03-installation.md +++ b/docs/_docs/03-installation.md @@ -2,31 +2,26 @@ title: "Installation" permalink: /docs/installation/ excerpt: "Instructions for installing the theme for new and existing Jekyll based sites." -last_modified_at: 2017-08-04T12:38:01-04:00 +last_modified_at: 2017-11-07T20:47:57-05:00 toc: true --- ## Install the Theme -There are several ways to install the theme: - **1.** For a **new site**, install the `minimal-mistakes-jekyll` theme gem or fork the Minimal Mistakes repo on GitHub following the steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | absolute_url }}). -**2.** For an **existing site** follow the **Ruby Gem Method** steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | absolute_url }}). If you plan to host with GitHub Pages I suggest you fork and rename the theme's repo, then clone it locally by running `git clone https://github.com/USERNAME/REPONAME.git` --- replacing **USERNAME** and **REPONAME** with your own. +If you plan to host with GitHub Pages be sure to properly setup [**jekyll-remote-theme**](https://github.com/benbalter/jekyll-remote-theme) as it is required for the theme to work properly. -
- copy GitHub repo URL -
Tap the copy to clipboard button (outlined in red above) to grab your GitHub repo's path.
-
+**2.** For an **existing site** follow the steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | absolute_url }}). Then work through the guidelines below for migration and setup. -**3.** And for those who don't want to mess with Git, you can download the theme as a ZIP file to work with locally. +**3.** And for those who'd like to make substantial edits to the theme, it can be downloaded as a ZIP file to customize. [ Download Minimal Mistakes Theme](https://github.com/mmistakes/minimal-mistakes/archive/master.zip){: .btn .btn--success} -**ProTip:** Be sure to remove `/docs` and `/test` if you forked Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don't littering up in your repo. +**ProTip:** Be sure to remove `/docs` and `/test` if you forked or downloaded Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don't littering up in your repo. {: .notice--info} ---- +## Theme Migration To move over any existing content you'll want to copy the contents of your `_posts` folder to the new site. Along with any pages, collections, data files, images, or other assets you may have.