From a54e04e6fd0084224cad5ba8460762b1c08298fc Mon Sep 17 00:00:00 2001 From: spf13 Date: Thu, 11 Jul 2013 22:04:57 -0400 Subject: [PATCH] Now support for config files as yaml, json or toml --- content/doc/configuration.md | 49 ++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 7 deletions(-) diff --git a/content/doc/configuration.md b/content/doc/configuration.md index 670a8e994..7be0fb0aa 100644 --- a/content/doc/configuration.md +++ b/content/doc/configuration.md @@ -7,15 +7,50 @@ 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. -The following is an example of a config file with the default values: +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. - SourceDir: "content" - LayoutDir: "layouts" - PublishDir: "public" - BuildDrafts: false - Tags: +**Please note the field names must be all lowercase** + +## Examples + +The following is an example of a yaml config file with the default values: + --- + sourcedir: "content" + layoutdir: "layouts" + publishdir: "public" + builddrafts: false + indexes: category: "categories" tag: "tags" - BaseUrl: "http://yourSite.com/" + baseurl: "http://yoursite.com/" ... + +The following is an example of a json config file with the default values: + { + "sourcedir": "content", + "layoutdir": "layouts", + "publishdir": "public", + "builddrafts": false, + "indexes": { + category: "categories", + tag: "tags" + }, + "baseurl": "http://yoursite.com/" + } + + +The following is an example of a toml config file with the default values: + + sourcedir = "content" + layoutdir = "layouts" + publishdir = "public" + builddrafts = false + baseurl = "http://yoursite.com/" + [indexes] + category = "categories" + tag = "tags" + +