2013-07-06 23:36:30 +00:00
|
|
|
---
|
|
|
|
title: "Configuring Hugo"
|
2013-08-17 12:34:25 +00:00
|
|
|
date: "2013-07-01"
|
|
|
|
aliases: ["/doc/configuration/"]
|
2013-10-25 22:42:46 +00:00
|
|
|
groups: ['gettingStarted']
|
|
|
|
linktitle: "Configuration"
|
2013-10-26 06:18:14 +00:00
|
|
|
groups_weight: 40
|
2013-07-08 21:57:01 +00:00
|
|
|
---
|
2013-07-04 15:32:55 +00:00
|
|
|
|
|
|
|
The directory structure and templates provide the majority of the
|
|
|
|
configuration for a site. In fact a config file isn't even needed for many websites
|
|
|
|
since the defaults used follow commonly used patterns.
|
|
|
|
|
2013-07-12 02:04:57 +00:00
|
|
|
Hugo expects to find the config file in the root of the source directory and
|
|
|
|
will look there first for a config.yaml file. If none is present it will
|
|
|
|
then look for a config.json file, followed by a config.toml file.
|
2013-07-07 02:31:43 +00:00
|
|
|
|
2013-07-12 02:04:57 +00:00
|
|
|
**Please note the field names must be all lowercase**
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
2013-08-17 12:34:25 +00:00
|
|
|
The following is an example of a yaml config file with the default values:
|
2013-07-12 03:29:14 +00:00
|
|
|
|
2013-07-12 02:04:57 +00:00
|
|
|
---
|
2013-08-05 18:14:40 +00:00
|
|
|
contentdir: "content"
|
2013-07-12 02:04:57 +00:00
|
|
|
layoutdir: "layouts"
|
|
|
|
publishdir: "public"
|
|
|
|
builddrafts: false
|
|
|
|
indexes:
|
2013-07-07 02:31:43 +00:00
|
|
|
category: "categories"
|
|
|
|
tag: "tags"
|
2013-07-12 02:04:57 +00:00
|
|
|
baseurl: "http://yoursite.com/"
|
2013-07-07 02:31:43 +00:00
|
|
|
...
|
2013-07-04 15:32:55 +00:00
|
|
|
|
2013-07-12 02:04:57 +00:00
|
|
|
|
2013-08-17 12:34:25 +00:00
|
|
|
The following is an example of a json config file with the default values:
|
2013-07-12 03:29:14 +00:00
|
|
|
|
2013-07-12 02:04:57 +00:00
|
|
|
{
|
2013-08-05 18:14:40 +00:00
|
|
|
"contentdir": "content",
|
2013-07-12 02:04:57 +00:00
|
|
|
"layoutdir": "layouts",
|
|
|
|
"publishdir": "public",
|
|
|
|
"builddrafts": false,
|
|
|
|
"indexes": {
|
2013-08-01 18:52:00 +00:00
|
|
|
"category": "categories",
|
|
|
|
"tag": "tags"
|
2013-07-12 02:04:57 +00:00
|
|
|
},
|
|
|
|
"baseurl": "http://yoursite.com/"
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2013-08-17 12:34:25 +00:00
|
|
|
The following is an example of a toml config file with the default values:
|
2013-07-12 02:04:57 +00:00
|
|
|
|
2013-08-05 18:14:40 +00:00
|
|
|
contentdir = "content"
|
2013-07-12 02:04:57 +00:00
|
|
|
layoutdir = "layouts"
|
|
|
|
publishdir = "public"
|
|
|
|
builddrafts = false
|
|
|
|
baseurl = "http://yoursite.com/"
|
|
|
|
[indexes]
|
|
|
|
category = "categories"
|
|
|
|
tag = "tags"
|
|
|
|
|