mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
102a3b95ae
This information was previously scattered around in the forums and mailing list. Add it to the official docs to make things easier for new users. Fixes #1167
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
---
|
|
aliases:
|
|
- /layout/404/
|
|
date: 2013-08-21
|
|
linktitle: "Custom 404 page"
|
|
menu:
|
|
main:
|
|
parent: layout
|
|
next: /taxonomies/overview
|
|
notoc: true
|
|
next: /templates/debugging
|
|
prev: /templates/sitemap
|
|
title: 404.html Templates
|
|
weight: 100
|
|
---
|
|
|
|
When using Hugo with [GitHub Pages](http://pages.github.com/), you can provide
|
|
your own template for a [custom 404 error page](https://help.github.com/articles/custom-404-pages/) by creating a 404.html template file in your `/layouts` folder. When Hugo generates your site, the `404.html` file will be placed in the root.
|
|
|
|
404 pages are of the type **"node"** and have all the [node
|
|
variables](/layout/variables/) available to use in the templates.
|
|
|
|
In addition to the standard node variables, the 404 page has access to
|
|
all site content accessible from `.Data.Pages`.
|
|
|
|
▾ layouts/
|
|
404.html
|
|
|
|
## 404.html
|
|
|
|
This is a basic example of a 404.html template:
|
|
|
|
{{ partial "header.html" . }}
|
|
{{ partial "subheader.html" . }}
|
|
|
|
<section id="main">
|
|
<div>
|
|
<h1 id="title">{{ .Title }}</h1>
|
|
</div>
|
|
</section>
|
|
|
|
{{ partial "footer.html" . }}
|
|
|
|
### Automatic Loading
|
|
|
|
Your 404.html file can be set to load automatically when a visitor enters a mistaken URL path, dependent upon the web serving environment you are using. For example:
|
|
|
|
* _Github Pages_ - it's automatic.
|
|
* _Apache_ - one way is to specify `ErrorDocument 404 /404.html` in an `.htaccess` file in the root of your site.
|
|
* _Nginx_ - you might specify `error_page 404 = /404.html;` in your `nginx.conf` file.
|
|
* _Amazon AWS S3_ - when setting a bucket up for static web serving, you can specify the error file.
|
|
|