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

82 lines
2 KiB
Markdown
Raw Normal View History

Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
---
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
aliases:
Converting front matter to YAML
2014-05-29 18:42:05 -04:00
- /doc/redirects/
- /doc/alias/
- /doc/aliases/
date: 2013-07-09
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: /extras/builders
prev: /taxonomies/ordering
title: Aliases
weight: 10
Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
---
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
For people migrating existing published content to Hugo, there's a good chance you need a mechanism to handle redirecting old URLs.
Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
Luckily, redirects can be handled easily with _aliases_ in Hugo.
Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
## Example
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
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 14:00:08 -04:00
Given a post on your current Hugo site, with a path of:
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
``content/posts/my-awesome-blog-post.md``
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 14:00:08 -04:00
... you create an "aliases" section in the frontmatter of your post, and add previous paths to that.
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
### TOML frontmatter
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
```toml
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
+++
...
[Docs] More copyediting * Add link to https://travis-ci.org/spf13/hugo * Correct heading levels in docs/content/community/mailing-list.md * Mention RFC 3339 as the `date` format set by `hugo new` * Mention that `hugo new` does not add `draft = true` when the user provides an archetype * List short examples of TOML and YAML side by side * Compact the Math template functions into a table * Put some notes into a blockquote
2015-01-17 02:45:53 -05:00
aliases = [
"/posts/my-original-url/",
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
"/2010/01/01/even-earlier-url.html"
[Docs] More copyediting * Add link to https://travis-ci.org/spf13/hugo * Correct heading levels in docs/content/community/mailing-list.md * Mention RFC 3339 as the `date` format set by `hugo new` * Mention that `hugo new` does not add `draft = true` when the user provides an archetype * List short examples of TOML and YAML side by side * Compact the Math template functions into a table * Put some notes into a blockquote
2015-01-17 02:45:53 -05:00
]
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
...
[Docs] More copyediting * Add link to https://travis-ci.org/spf13/hugo * Correct heading levels in docs/content/community/mailing-list.md * Mention RFC 3339 as the `date` format set by `hugo new` * Mention that `hugo new` does not add `draft = true` when the user provides an archetype * List short examples of TOML and YAML side by side * Compact the Math template functions into a table * Put some notes into a blockquote
2015-01-17 02:45:53 -05:00
+++
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
```
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
### YAML frontmatter
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
```yaml
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
---
...
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
aliases:
- /posts/my-original-url/
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
- /2010/01/01/even-earlier-url.html
...
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
---
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
```
Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
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 14:00:08 -04:00
Now when you visit any of the locations specified in aliases, _assuming the same site domain_, you'll be redirected to the page they are specified on.
Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
## Important Behaviors
1. *Hugo makes no assumptions about aliases. They also don't change based
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
on your UglyURLs setting. You need to provide absolute path to your webroot
and the complete filename or directory.*
Adding support for aliases (redirects)
2013-08-10 10:35:34 -04:00
2. *Aliases are rendered prior to any content and will be overwritten by
any content with the same location.*
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
## How Hugo Aliases Work
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 14:00:08 -04:00
When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target.
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
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 14:00:08 -04:00
Assuming a baseurl of `mysite.tld`, the contents of the html file will look something like:
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
```html
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
<!DOCTYPE html>
<html>
<head>
<link rel="canonical" href="http://mysite.tld/posts/my-original-url"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="refresh" content="0;url=http://mysite.tld/posts/my-original-url"/>
</head>
</html>
Docs: Add nohighlight shortcode and improve formatting And some random formatting and copyediting fixes. See also #1708
2015-12-23 11:31:07 -05:00
```
Edits on aliases, comments, theme customizing Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section. Added Discourse to comments section. Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-12 02:56:56 -04:00
The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case.
Reference in a new issue Copy permalink