dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upgrading docs: add note about removing relative permalinks support (2 to 3) 

Ref: #4303.
This commit is contained in:
Parker Moore 2016-01-04 11:14:19 -08:00
parent c38e1fcbb8
commit 046928e395
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
site/_docs/upgrading/2-to-3.md
View File

@ -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!_