2013-07-06 23:36:30 +00:00
---
2014-05-29 22:42:05 +00:00
aliases:
- /doc/configuration/
date: 2013-07-01
linktitle: Configuration
2014-04-23 07:00:11 +00:00
menu:
main:
2014-05-29 22:42:05 +00:00
parent: getting started
next: /overview/source-directory
notoc: true
prev: /overview/usage
title: Configuring Hugo
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
2014-09-03 04:12:26 +00:00
configuration for a site. In fact, a config file isn't even needed for many
2014-05-27 22:32:57 +00:00
websites since the defaults follow commonly used patterns.
2013-07-04 15:32:55 +00:00
2013-07-12 02:04:57 +00:00
Hugo expects to find the config file in the root of the source directory and
2014-09-03 04:12:26 +00:00
will look there first for a `config.toml` file. If none is present, it will
2014-05-27 22:32:57 +00:00
then look for a `config.yaml` file, followed by a `config.json` file.
2013-07-07 02:31:43 +00:00
2014-05-27 22:32:57 +00:00
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.
2013-07-12 02:04:57 +00:00
## Examples
2014-05-27 22:32:57 +00:00
The following is an example of a typical yaml config file:
2014-05-15 13:58:55 +00:00
---
baseurl: "http://yoursite.example.com/"
...
2013-07-12 02:04:57 +00:00
2015-01-05 10:37:47 +00:00
The following is an example of a toml config file with some of the default values. Values under `[params]` will populate the `.Site.Params` variable for use in templates:
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
2013-11-18 23:31:02 +00:00
baseurl = "http://yoursite.example.com/"
2014-01-03 23:36:53 +00:00
canonifyurls = true
2014-09-27 03:44:09 +00:00
2013-07-12 02:04:57 +00:00
[indexes]
2015-01-05 10:37:47 +00:00
category = "categories"
tag = "tags"
[params]
description = "Tesla's Awesome Hugo Site"
author = "Nikola Tesla"
2013-07-12 02:04:57 +00:00
2013-11-18 23:31:02 +00:00
Here is a yaml configuration file which sets a few more options
2014-05-15 13:58:55 +00:00
---
baseurl: "http://yoursite.example.com/"
title: "Yoyodyne Widget Blogging"
2014-09-27 03:44:09 +00:00
footnotereturnlinkcontents: "↩"
2014-05-15 13:58:55 +00:00
permalinks:
post: /:year/:month/:title/
params:
Subtitle: "Spinning the cogs in the widgets"
AuthorName: "John Doe"
GitHubUser: "spf13"
ListOfFoo:
- "foo1"
- "foo2"
SidebarRecentLimit: 5
...
2014-05-27 22:32:57 +00:00
2014-12-26 15:04:49 +00:00
## Configure Blackfriday rendering
[Blackfriday ](https://github.com/russross/blackfriday ) is the [Markdown ](http://daringfireball.net/projects/markdown/ ) rendering engine used in Hugo. The Blackfriday configuration in Hugo is mostly a set of sane defaults that should fit most use cases.
But Hugo does expose some options -- in the table below matched with the corresponding flag in the [Blackfriday source ](https://github.com/russross/blackfriday/blob/master/html.go ):
Flag | Default | Blackfriday flag | Purpose
--- | --- | --- | ---
angledQuotes | false | HTML_SMARTYPANTS_ANGLED_QUOTES | Enable angled double quotes (`« »`)
**Note** that these flags must be grouped under the `blackfriday` key and can be set on **both site and page level** . If set on page, it will override the site setting.
```
blackfriday:
2014-12-26 17:11:05 +00:00
angledQuotes = true
2014-12-26 15:04:49 +00:00
```
2014-08-15 18:39:12 +00:00
## Notes
2014-10-07 23:52:58 +00:00
Config changes do not reflect with [Live Reload ](/extras/livereload ).
2014-08-15 18:39:12 +00:00
Please restart `hugo server --watch` whenever you make a config change.