hugo/docs/content/overview/configuration.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

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/"]
linktitle: "Configuration"
weight: 40
notoc: true
menu:
main:
parent: 'getting started'
prev: '/overview/usage'
next: '/overview/source-directory'
---
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 follow commonly used patterns.
2013-07-04 15:32:55 +00:00
Hugo expects to find the config file in the root of the source directory and
will look there first for a `config.toml` file. If none is present it will
then look for a `config.yaml` file, followed by a `config.json` file.
The config file is a site-wide config. The config file provides directions to
hugo on how to build the site as well as site-wide parameters and menus.
## Examples
The following is an example of a typical yaml config file:
---
baseurl: "http://yoursite.example.com/"
...
The following is an example of a toml config file with some of the default values:
2013-08-05 18:14:40 +00:00
contentdir = "content"
layoutdir = "layouts"
publishdir = "public"
builddrafts = false
baseurl = "http://yoursite.example.com/"
canonifyurls = true
[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
...