From 046928e39584e3d15a9b9a4a73a2e8e35ff51bee Mon Sep 17 00:00:00 2001 From: Parker Moore Date: Mon, 4 Jan 2016 11:14:19 -0800 Subject: [PATCH] upgrading docs: add note about removing relative permalinks support (2 to 3) Ref: #4303. --- site/_docs/upgrading/2-to-3.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/site/_docs/upgrading/2-to-3.md b/site/_docs/upgrading/2-to-3.md index c01be517..e3529f63 100644 --- a/site/_docs/upgrading/2-to-3.md +++ b/site/_docs/upgrading/2-to-3.md @@ -71,15 +71,22 @@ 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 +### Relative Permalink support removed -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**: +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. +{% highlight text %} +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. +{% endhighlight %} -This can be fixed by removing the following line from your _config.yml file: - - relative_permalinks: true +This can be fixed by removing the following line from your `_config.yml` file: +{% highlight yaml %} +relative_permalinks: true +{% endhighlight %} _Did we miss something? Please click "Improve this page" above and add a section. Thanks!_