github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-25 01:32:45 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/extras/urls.md

71 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 23:36:53 +00:00
---
aliases:
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
- /doc/urls/
docs: Document relativeURLs Fixes #1342
2016-05-07 19:39:40 +00:00
lastmod: 2016-05-07
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
date: 2014-01-03
Implementing new menu system in the docs site
2014-04-23 07:00:11 +00:00
menu:
main:
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
parent: extras
docs: Cleanup Extras menu ordering
2016-12-12 00:55:36 +00:00
next: /community/mailing-list
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
notoc: true
docs: Cleanup Extras menu ordering
2016-12-12 00:55:36 +00:00
prev: /extras/localfiles
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
title: URLs
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 23:36:53 +00:00
---
Adding documentation on Pretty Urls
2014-02-21 00:04:29 +00:00
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00:00
## Pretty URLs
Adding documentation on Pretty Urls
2014-02-21 00:04:29 +00:00
docs: Fix typo in url extras
2015-09-02 19:22:21 +00:00
By default, Hugo creates content with 'pretty' URLs. For example,
[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-23 01:04:07 +00:00
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-21 00:04:29 +00: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-23 01:04:07 +00:00
If you would like to have what we call "ugly URLs",
e.g. 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`,
Complete the Url-to-URL transition in docs See #959
2015-09-09 05:29:04 +00:00
or use the `--uglyURLs=true` flag on the command line.
Adding documentation on Pretty Urls
2014-02-21 00:04:29 +00:00
Minor proofreading corrections to Hugo docs
2014-08-31 11:08:36 +00: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-23 01:04:07 +00:00
specify this in the front matter under the `url` key. See [Content
doc: Strip trailing whitespace; other revisions Make some random and non-comprehensive changes to the template functions documentation to make them more consistent.
2015-08-04 18:00:08 +00:00
Organization](/content/organization/) for more details.
Adding documentation on Pretty Urls
2014-02-21 00:04:29 +00: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-23 01:04:07 +00:00
By default, all relative URLs encountered in the input are left unmodified,
[Docs] Clarify the switch to `canonifyurls = false` as default Quote from @spf13: "I also think it's the better default and should continue to be the case going forward." Also mention the use of `hugo config` to check the current value of `canonifyurls`, thanks to suggestion by @bep. Fixes #802
2015-02-21 21:46:12 +00:00
e.g. `/css/foo.css` would stay as `/css/foo.css`,
all: Unify case of config variable names All config variables starts with low-case and uses camelCase. If there is abbreviation at the beginning of the name, the whole abbreviation will be written in low-case. If there is abbreviation at the end of the name, the whole abbreviation will be written in upper-case. For example, rssURI.
2016-10-24 18:56:00 +00:00
i.e. `canonifyURLs` defaults to `false`.
[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-23 01:04:07 +00:00
all: Unify case of config variable names All config variables starts with low-case and uses camelCase. If there is abbreviation at the beginning of the name, the whole abbreviation will be written in low-case. If there is abbreviation at the end of the name, the whole abbreviation will be written in upper-case. For example, rssURI.
2016-10-24 18:56:00 +00:00
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
[Docs] Clarify the switch to `canonifyurls = false` as default Quote from @spf13: "I also think it's the better default and should continue to be the case going forward." Also mention the use of `hugo config` to check the current value of `canonifyurls`, thanks to suggestion by @bep. Fixes #802
2015-02-21 21:46:12 +00:00
`config.toml`, the relative URL `/css/foo.css` would be turned into
[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-23 01:04:07 +00:00
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 23:36:53 +00: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-23 01:04:07 +00:00
all: Unify case of config variable names All config variables starts with low-case and uses camelCase. If there is abbreviation at the beginning of the name, the whole abbreviation will be written in low-case. If there is abbreviation at the end of the name, the whole abbreviation will be written in upper-case. For example, rssURI.
2016-10-24 18:56:00 +00:00
> Note: In the May 2014 release of Hugo v0.11, the default value of `canonifyURLs` was switched from `true` to `false`, which we think is the better default and should continue to be the case going forward. So, please verify and adjust your website accordingly if you are upgrading from v0.10 or older versions.
[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-23 01:04:07 +00:00
all: Unify case of config variable names All config variables starts with low-case and uses camelCase. If there is abbreviation at the beginning of the name, the whole abbreviation will be written in low-case. If there is abbreviation at the end of the name, the whole abbreviation will be written in upper-case. For example, rssURI.
2016-10-24 18:56:00 +00:00
To find out the current value of `canonifyURLs` for your website, you may use the handy `hugo config` command added in v0.13:
[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-23 01:04:07 +00:00
[Docs] Clarify the switch to `canonifyurls = false` as default Quote from @spf13: "I also think it's the better default and should continue to be the case going forward." Also mention the use of `hugo config` to check the current value of `canonifyurls`, thanks to suggestion by @bep. Fixes #802
2015-02-21 21:46:12 +00:00
hugo config | grep -i canon
[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-23 01:04:07 +00:00
[Docs] Clarify the switch to `canonifyurls = false` as default Quote from @spf13: "I also think it's the better default and should continue to be the case going forward." Also mention the use of `hugo config` to check the current value of `canonifyurls`, thanks to suggestion by @bep. Fixes #802
2015-02-21 21:46:12 +00:00
Or, if you are on Windows and do not have `grep` installed:
[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-23 01:04:07 +00:00
[Docs] Clarify the switch to `canonifyurls = false` as default Quote from @spf13: "I also think it's the better default and should continue to be the case going forward." Also mention the use of `hugo config` to check the current value of `canonifyurls`, thanks to suggestion by @bep. Fixes #802
2015-02-21 21:46:12 +00:00
hugo config | FINDSTR /I canon
[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-23 01:04:07 +00:00
docs: Document relativeURLs Fixes #1342
2016-05-07 19:39:40 +00:00
## Relative URLs
By default, all relative URLs are left unchanged by Hugo,
which can be problematic when you want to make your site browsable from a local file system.
Setting `relativeURLs` to `true` in the site configuration will cause Hugo to rewrite all relative URLs to be relative to the current content.
For example, if the `/post/first/` page contained a link with a relative URL of `/about/`, Hugo would rewrite that URL to `../../about/`.
Reference in a new issue Copy permalink