github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/extras/urls.md

102 lines
2.8 KiB
Markdown
Raw Normal View History

Add `canonifyurls` config option. Be able to inhibit AbsURL canonicalization of content, on a site configuration basis. Advantages of being able to inhibit this include making it easier to rendering on other hostnames, and being able to include resources on http or https depending on how this page was retrieved, avoiding mixed-mode client complaints without adding latency for plain http.
2014-01-03 18:36:53 -05:00
---
aliases:
Converting front matter to YAML
2014-05-29 18:42:05 -04:00
- /doc/urls/
date: 2014-01-03
Implementing new menu system in the docs site
2014-04-23 03:00:11 -04:00
menu:
main:
Converting front matter to YAML
2014-05-29 18:42:05 -04:00
parent: extras
next: /community/mailing-list
notoc: true
prev: /extras/toc
title: URLs
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</*…*/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode.
2014-11-25 03:07:18 -05:00
weight: 110
Add `canonifyurls` config option. Be able to inhibit AbsURL canonicalization of content, on a site configuration basis. Advantages of being able to inhibit this include making it easier to rendering on other hostnames, and being able to include resources on http or https depending on how this page was retrieved, avoiding mixed-mode client complaints without adding latency for plain http.
2014-01-03 18:36:53 -05:00
---
Adding documentation on Pretty Urls
2014-02-20 19:04:29 -05:00
Minor proofreading corrections to Hugo docs
2014-08-31 07:08:36 -04:00
## Pretty URLs
Adding documentation on Pretty Urls
2014-02-20 19:04:29 -05:00
[Docs] Document the new (temp?) default of `canonifyurls = false` Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/ warning the reader that a `canonifyurls = true` must be added for Spencer's old example files to work. Fixes #802
2015-01-22 20:04:07 -05:00
By default, Hugo create content with 'pretty' URLs. For example,
content created at `/content/extras/urls.md` will be rendered at
`/public/extras/urls/index.html`, thus accessible from the browser
at http://example.com/extras/urls/. No non-standard server-side
configuration is required for these pretty URLs to work.
Adding documentation on Pretty Urls
2014-02-20 19:04:29 -05:00
[Docs] Document the new (temp?) default of `canonifyurls = false` Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/ warning the reader that a `canonifyurls = true` must be added for Spencer's old example files to work. Fixes #802
2015-01-22 20:04:07 -05:00
If you would like to have what we call "ugly URLs",
e.g.&nbsp;http://example.com/extras/urls.html, you are in luck.
Hugo supports the ability to create your entire site with ugly URLs.
Simply add `uglyurls = true` to your site-wide `config.toml`,
or use the `--uglyUrls=true` flag on the command line.
Adding documentation on Pretty Urls
2014-02-20 19:04:29 -05:00
Minor proofreading corrections to Hugo docs
2014-08-31 07:08:36 -04:00
If you want a specific piece of content to have an exact URL, you can
[Docs] Document the new (temp?) default of `canonifyurls = false` Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/ warning the reader that a `canonifyurls = true` must be added for Spencer's old example files to work. Fixes #802
2015-01-22 20:04:07 -05:00
specify this in the front matter under the `url` key. See [Content
Fixing broken link. Fixed #278.
2014-05-09 11:32:06 -04:00
Organization](/content/organization/) for more details.
Adding documentation on Pretty Urls
2014-02-20 19:04:29 -05:00
## Canonicalization
[Docs] Document the new (temp?) default of `canonifyurls = false` Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/ warning the reader that a `canonifyurls = true` must be added for Spencer's old example files to work. Fixes #802
2015-01-22 20:04:07 -05:00
<!--
Add `canonifyurls` config option. Be able to inhibit AbsURL canonicalization of content, on a site configuration basis. Advantages of being able to inhibit this include making it easier to rendering on other hostnames, and being able to include resources on http or https depending on how this page was retrieved, avoiding mixed-mode client complaints without adding latency for plain http.
2014-01-03 18:36:53 -05:00
By default, all relative URLs encountered in the input will be canonicalized
using `baseurl`, so that a link `/css/foo.css` becomes
`http://yoursite.example.com/css/foo.css`.
[Docs] Document the new (temp?) default of `canonifyurls = false` Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/ warning the reader that a `canonifyurls = true` must be added for Spencer's old example files to work. Fixes #802
2015-01-22 20:04:07 -05:00
By setting `canonifyurls` to `false` will prevent this canonicalization.
-->
By default, all relative URLs encountered in the input are left unmodified,
e.g. `/css/foo.css` would stay as `/css/foo.css`.
By setting `canonifyurls` to `true`, all relative URLs would instead
be *canonicalized* using `baseurl`. For example, assuming you have
`baseurl = http://yoursite.example.com/` defined in the site-wide
config.toml, the relative URL `/css/foo.css` would be turned into
the absolute URL `http://yoursite.example.com/css/foo.css`.
Add `canonifyurls` config option. Be able to inhibit AbsURL canonicalization of content, on a site configuration basis. Advantages of being able to inhibit this include making it easier to rendering on other hostnames, and being able to include resources on http or https depending on how this page was retrieved, avoiding mixed-mode client complaints without adding latency for plain http.
2014-01-03 18:36:53 -05:00
Benefits of canonicalization include fixing all URLs to be absolute, which may
aid with some parsing tasks. Note though that all real browsers handle this
client-side without issues.
Benefits of non-canonicalization include being able to have resource inclusion
be scheme-relative, so that http vs https can be decided based on how this
page was retrieved.
[Docs] Document the new (temp?) default of `canonifyurls = false` Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/ warning the reader that a `canonifyurls = true` must be added for Spencer's old example files to work. Fixes #802
2015-01-22 20:04:07 -05:00
### Caveat: Default of `canonifyurls` changed in v0.11
<table class="table table-bordered">
<thead>
<tr>
<th>Hugo Version</th>
<th>Release Date</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>v0.9</td>
<td>2013-11-15</td>
<td><code>canonifyurls = true</code> <small>(non-configurable)</small></td>
</tr>
<tr>
<td>v0.10</td>
<td>2014-03-01</td>
<td><code>canonifyurls = true</code></td>
</tr>
<tr>
<td>v0.11</td>
<td>2014-05-29</td>
<td><code>canonifyurls = false</code></td>
</tr>
<tr>
<td>v0.12</td>
<td>2014-09-01</td>
<td><code>canonifyurls = false</code></td>
</tr>
<tr>
<td>v0.13-DEV</td>
<td><small>in development</small></td>
<td><code>canonifyurls = false</code> <small>(as of January 2015)</small></td>
</tr>
</tbody>
</table>
Reference in a new issue Copy permalink