diff --git a/content/doc/configuration.md b/content/doc/configuration.md index eea530f02..09cfb48f3 100644 --- a/content/doc/configuration.md +++ b/content/doc/configuration.md @@ -7,13 +7,15 @@ 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 +The following is an example of a config file with the default values: + + SourceDir: "content" + LayoutDir: "layouts" + PublishDir: "public" + BuildDrafts: false + Tags: + category: "categories" + tag: "tags" + BaseUrl: "http://yourSite.com/" + ... - { - "SourceDir" : "content", - "LayoutDir" : "layouts", - "PublishDir" : "public", - "BuildDrafts" : false, - "Tags" : { "category" : "categories", "tag" : "tags" }, - "BaseUrl" : "http://yourSite.com/" - } diff --git a/content/doc/example.md b/content/doc/example.md index 75f35f2bf..03595ad10 100644 --- a/content/doc/example.md +++ b/content/doc/example.md @@ -7,16 +7,16 @@ Somethings are better shown than explained. The following is a very basic exampl **mysite/project/nitro.md <- http://mysite.com/project/nitro.html** - { - "Title": "Nitro : A quick and simple profiler for golang", - "Description": "", - "Keywords": [ "Development", "golang", "profiling" ], - "Tags": [ "Development", "golang", "profiling" ], - "Pubdate": "2013-06-19", - "Topics": [ "Development", "GoLang" ], - "Slug": "nitro", - "project_url": "http://github.com/spf13/nitro" - } + --- + Title: "Nitro : A quick and simple profiler for golang" + Description": "" + Keywords": [ "Development", "golang", "profiling" ] + Tags": [ "Development", "golang", "profiling" ] + Pubdate": "2013-06-19" + Topics": [ "Development", "GoLang" ] + Slug": "nitro" + project_url": "http://github.com/spf13/nitro" + ... # Nitro diff --git a/content/doc/front-matter.md b/content/doc/front-matter.md index 3f0083713..af930b25f 100644 --- a/content/doc/front-matter.md +++ b/content/doc/front-matter.md @@ -5,18 +5,21 @@ Pubdate: "2013-07-01" The front matter is one of the features that gives Hugo it's strength. It enables you to include the meta data of the content right with it. Hugo supports a few -different formats. The main format supported is JSON. Here is an example: +different formats. The main format supported is YAML. Here is an example: - { - "Title": "spf13-vim 3.0 release and new website", - "Description": "spf13-vim is a cross platform distribution of vim plugins and resources for Vim.", - "Tags": [ ".vimrc", "plugins", "spf13-vim", "vim" ], - "Pubdate": "2012-04-06", - "Categories": [ "Development", "VIM" ], - "Slug": "spf13-vim-3-0-release-and-new-website" - } + --- + Title: "spf13-vim 3.0 release and new website" + Description: "spf13-vim is a cross platform distribution of vim plugins and resources for Vim." + Tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ] + Pubdate: "2012-04-06" + Categories: + - "Development" + - "VIM" + Slug: "spf13-vim-3-0-release-and-new-website" + ... ### Variables + There are a few predefined variables that Hugo is aware of and utilizes. The user can also create any variable they want to. These will be placed into the `.Params` variable available to the templates. @@ -31,6 +34,8 @@ any variable they want to. These will be placed into the `.Params` variable avai **Draft** If true the content will not be rendered unless `hugo` is called with -d
**Type** The type of the content (will be derived from the directory automatically if unset).
+**Markup** (Experimental) Specify "rst" for reStructuredText (requires + `rst2html`,) or "md" (default) for the Markdown.
**Slug** The token to appear in the tail of the url.
*or*
**Url** The full path to the content from the web root.