From 13f520f2b40079c3293d199a2672c62ad60aec38 Mon Sep 17 00:00:00 2001 From: Alistair Calder Date: Wed, 30 Dec 2015 16:07:15 -0800 Subject: [PATCH] Added content on relative permalinks Could not find documentation on issues with relative permalinks. Added what fixed it for me. --- site/_docs/upgrading/2-to-3.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/site/_docs/upgrading/2-to-3.md b/site/_docs/upgrading/2-to-3.md index cdc69fd0..c01be517 100644 --- a/site/_docs/upgrading/2-to-3.md +++ b/site/_docs/upgrading/2-to-3.md @@ -71,4 +71,15 @@ go back to using Pygments, set `highlighter: pygments` in your `_config.yml` file and run `gem install pygments.rb` or add `gem 'pygments.rb'` to your project's `Gemfile`. +### Relative Permalinks deprecated + +In Jekyll 3 and above, relative permalinks have been deprecated. If you created your site using Jekyll 2 and below, you may receive the following error when trying to **serve** or **build**: + + Since v3.0, permalinks for pages in subfolders must be relative to the site source directory, not the parent directory. Check http://jekyllrb.com/docs/upgrading/ for more info. + +This can be fixed by removing the following line from your _config.yml file: + + relative_permalinks: true + + _Did we miss something? Please click "Improve this page" above and add a section. Thanks!_