hugo/docs/content/overview/configuration.md

79 lines
2 KiB
Markdown
Raw Normal View History

2013-07-06 19:36:30 -04:00
---
title: "Configuring Hugo"
2013-08-17 08:34:25 -04:00
date: "2013-07-01"
aliases: ["/doc/configuration/"]
groups: ['gettingStarted']
linktitle: "Configuration"
groups_weight: 40
---
2013-07-04 11:32:55 -04: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-04 11:32:55 -04: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.
**Please note the field names must be all lowercase**
## Examples
2013-08-17 08:34:25 -04:00
The following is an example of a yaml config file with the default values:
2013-07-11 23:29:14 -04:00
---
2013-08-05 14:14:40 -04:00
contentdir: "content"
layoutdir: "layouts"
publishdir: "public"
builddrafts: false
indexes:
category: "categories"
tag: "tags"
baseurl: "http://yoursite.example.com/"
...
2013-07-04 11:32:55 -04:00
2013-08-17 08:34:25 -04:00
The following is an example of a json config file with the default values:
2013-07-11 23:29:14 -04:00
{
2013-08-05 14:14:40 -04:00
"contentdir": "content",
"layoutdir": "layouts",
"publishdir": "public",
"builddrafts": false,
"indexes": {
"category": "categories",
"tag": "tags"
},
"baseurl": "http://yoursite.example.com/"
}
2013-08-17 08:34:25 -04:00
The following is an example of a toml config file with the default values:
2013-08-05 14:14:40 -04:00
contentdir = "content"
layoutdir = "layouts"
publishdir = "public"
builddrafts = false
baseurl = "http://yoursite.example.com/"
[indexes]
category = "categories"
tag = "tags"
Here is a yaml configuration file which sets a few more options
---
baseurl: "http://yoursite.example.com/"
title: "Yoyodyne Widget Blogging"
permalinks:
post: /:year/:month/:title/
params:
Subtitle: "Spinning the cogs in the widgets"
AuthorName: "John Doe"
GitHubUser: "spf13"
ListOfFoo:
- "foo1"
- "foo2"
SidebarRecentLimit: 5
...