mirror/gohugoio-hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-05-11 05:54:58 +00:00
Code Issues Releases Activity

Documentation updates, mostly for my bits

Browse Source 
* extras/permalinks.md added, weighted to third in the extras menu
* examples added to layout/go-templates.md, using `.Site.Params`
* mention `.Site.Params` in layout/variables.md
* update meta/release-notes.md to mention `first` and the permalinks
* update overview/configuration.md to use reserved-for-documentation
  domains and with another example, nudging towards permalinks and site
  parameters, with three different data-types shown for the latter

Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
This commit is contained in:
Phil Pennock
2013-11-18 18:31:02 -05:00
committed by Noah Campbell
parent 07978e4a49
commit e425226a28
5 changed files with 117 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/content/overview/configuration.md
View File

@@ -8,12 +8,12 @@ groups_weight: 40
---
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.
configuration for a site. In fact a config file isn't even needed for many
websites since the defaults used follow commonly used patterns.
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.
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**
@@ -29,7 +29,7 @@ The following is an example of a yaml config file with the default values:
indexes:
category: "categories"
tag: "tags"
baseurl: "http://yoursite.com/"
baseurl: "http://yoursite.example.com/"
...
@@ -44,7 +44,7 @@ The following is an example of a json config file with the default values:
"category": "categories",
"tag": "tags"
},
"baseurl": "http://yoursite.com/"
"baseurl": "http://yoursite.example.com/"
}
@@ -54,8 +54,25 @@ The following is an example of a toml config file with the default values:
layoutdir = "layouts"
publishdir = "public"
builddrafts = false
baseurl = "http://yoursite.com/"
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
...