4.4 KiB
| title | permalink | excerpt | sidebar | modified | ||||
|---|---|---|---|---|---|---|---|---|
| Installation | /docs/installation/ | Instructions for installing the theme for new and existing Jekyll based sites. |
|
2016-04-13T15:54:02-04:00 |
{% include base_path %}
Install the Theme
There are several ways to install the theme:
1. For a new site, fork the Minimal Mistakes repo on GitHub. If you plan on hosting your site with GitHub Pages follow the steps outlined in the [Quick-Start Guide]({{ base_path }}/docs/quick-start-guide/).
2. For an existing site you have some more work ahead of you. What I suggest is to fork and rename the theme's repo as before, then clone it locally by running git clone https://github.com/USERNAME/REPONAME.git --- replacing USERNAME and REPONAME with your own.
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.
[ Download Minimal Mistakes Theme]({{ site.gh_repo }}/archive/master.zip){: .btn .btn--success}
ProTip: Be sure to delete the gh-pages branch if you forked Minimal Mistakes. This branch contains the documentation and demo site for the theme and you probably don't want that showing up in your repo.
{: .notice--info}
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.
Next you'll need to convert posts and pages to use the proper layouts and settings. In most cases you simply need to update _config.yml to your liking and set the correct layout in their YAML Front Matter.
Front Matter defaults are your friend and I encourage you to leverage them instead of setting a layout and other global options in each post/page's YAML Front Matter.
Posts can be configured to use the single layout --- with reading time, comments, social sharing links, and related posts enabled. Adding the following to _config.yml will set these defaults for all posts:
defaults:
# _posts
- scope:
path: ""
type: posts
values:
layout: single
read_time: true
comments: true
share: true
related: true
Post/Page Settings: Be sure to read through the "Working with..." documentation to learn about all the options available to you. The theme has been designed to be flexible --- with numerous settings for each. {: .notice--info}
Install Dependencies
If this is your first time using Jekyll be sure to read through the official documentation before jumping in. This guide assumes you have Ruby v2 installed and a basic understanding of how Jekyll works.
To keep your sanity and better manage dependencies I strongly urge you to install Bundler with gem install bundler and use the included [Gemfile]({{ site.gh_repo }}/blob/master/Gemfile). The theme's Gemfile includes the github-pages gem to maintain a local Jekyll environment in sync with GitHub Pages.
If you're not planning on hosting with GitHub Pages and want to leverage features found in the latest version of Jekyll, replace gem "github-pages" with gem "jekyll" in your Gemfile. In either case run the following:
$ bundle install
Depending on what gems you already have installed you may have to run bundle update to clear up any dependency issues. Bundler is usually pretty good at letting you know what gems need updating or have issues installing, to further investigate.
When using Bundler to manage gems you'll want to run Jekyll using bundle exec jekyll serve and bundle exec jekyll build.
Doing so executes the gem versions specified in Gemfile.lock. Sure you can test your luck with a naked jekyll serve, but I wouldn't suggest it. A lot of Jekyll errors originate from outdated or conflicting gems fighting with each other. So do yourself a favor and just use Bundler.