From b2b54b8ca70c8186a39257b83aec29151ccfd631 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 11 Nov 2014 11:30:05 -0500 Subject: [PATCH] Add note about running Jekyll with bundle exec --- theme-setup/index.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/theme-setup/index.md b/theme-setup/index.md index 848bc5da..2bdbcc6c 100644 --- a/theme-setup/index.md +++ b/theme-setup/index.md @@ -44,6 +44,22 @@ If you want to use Minimal Mistakes with an existing Jekyll site follow these st --- +## Running Jekyll + +If `jekyll build` and `jekyll serve` throw errors you may have to run Jekyll with `bundled exec` instead. + +> In some cases, running executables without bundle exec may work, if the executable happens to be installed in your system and does not pull in any gems that conflict with your bundle. +> +>However, this is unreliable and is the source of considerable pain. Even if it looks like it works, it may not work in the future or on another machine. + +{% highlight text %} +bundle exec jekyll build + +bundle exec jekyll serve +{% endhighlight %} + +--- + ## Scaffolding How Minimal Mistakes is organized and what the various files are. All posts, layouts, includes, stylesheets, assets, and whatever else is grouped nicely under the root folder. The compiled Jekyll site outputs to `_site/`.