From 004607f7a1d64b69284fa067b0ae75b7a85eebf7 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 11 Nov 2014 11:31:40 -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 4bd13e7..9170e68 100644 --- a/theme-setup/index.md +++ b/theme-setup/index.md @@ -39,6 +39,22 @@ If you want to use So Simple with an existing Jekyll site follow these steps: --- +## 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 So Simple 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/`.