mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-12 04:05:00 -04:00
Now support for config files as yaml, json or toml
This commit is contained in:
parent
0a18ab32ad
commit
a54e04e6fd
@ -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
|
configuration for a site. In fact a config file isn't even needed for many websites
|
||||||
since the defaults used follow commonly used patterns.
|
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"
|
**Please note the field names must be all lowercase**
|
||||||
LayoutDir: "layouts"
|
|
||||||
PublishDir: "public"
|
## Examples
|
||||||
BuildDrafts: false
|
|
||||||
Tags:
|
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"
|
category: "categories"
|
||||||
tag: "tags"
|
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"
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user