Adding support for TOML, updating documentation

This commit is contained in:
spf13 2013-07-08 22:23:54 -04:00
parent f2c0e41acd
commit 1159b69c66
5 changed files with 64 additions and 25 deletions

View File

@ -1,6 +1,6 @@
--- ---
title: "Contributors" title: "Contributors"
Pubdate: "2013-07-01" date: "2013-07-01"
--- ---
Hugo was built with love and golang by: Hugo was built with love and golang by:

View File

@ -16,7 +16,7 @@ Somethings are better shown than explained. The following is a very basic exampl
Topics": [ "Development", "GoLang" ] Topics": [ "Development", "GoLang" ]
Slug": "nitro" Slug": "nitro"
project_url": "http://github.com/spf13/nitro" project_url": "http://github.com/spf13/nitro"
... ---
# Nitro # Nitro

View File

@ -1,43 +1,82 @@
--- +++
title: "Front Matter" title = "Front Matter"
Pubdate: "2013-07-01" date = "2013-07-01"
--- +++
The front matter is one of the features that gives Hugo it's strength. It enables 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 you to include the meta data of the content right with it. Hugo supports a few
different formats. The main format supported is YAML. Here is an example: different formats each with their own identifying tokens.
Supported formats: <br>
**YAML**, identified by '\-\-\-'. <br>
**TOML**, indentified with '+++'.<br>
**JSON**, a single JSON object which is surrounded by '{' and '}' each on their own line.
### YAML Example
--- ---
Title: "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." description: "spf13-vim is a cross platform distribution of vim plugins and resources for Vim."
Tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ] tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ]
Pubdate: "2012-04-06" pubdate: "2012-04-06"
Categories: categories:
- "Development" - "Development"
- "VIM" - "VIM"
Slug: "spf13-vim-3-0-release-and-new-website" slug: "spf13-vim-3-0-release-and-new-website"
--- ---
Content of the file goes Here
### TOML 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"
+++
Content of the file goes Here
### JSON 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" ],
"date": "2012-04-06",
"categories": [
"Development",
"VIM"
],
"slug": "spf13-vim-3-0-release-and-new-website",
}
Content of the file goes Here
### Variables ### Variables
There are a few predefined variables that Hugo is aware of and utilizes. The user can also create 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. any variable they want to. These will be placed into the `.Params` variable available to the templates.
**Field names are case insensitive.**
#### Required #### Required
**Title** The title for the content. <br> **title** The title for the content. <br>
**Description** The description for the content.<br> **description** The description for the content.<br>
**Pubdate** The date the content will be sorted by.<br> **date** The date the content will be sorted by.<br>
**Indexes** These will use the field name of the plural form of the index (see tags and categories above) **indexes** These will use the field name of the plural form of the index (see tags and categories above)
#### Optional #### Optional
**Draft** If true the content will not be rendered unless `hugo` is called with -d<br> **draft** If true the content will not be rendered unless `hugo` is called with -d<br>
**Type** The type of the content (will be derived from the directory automatically if unset).<br> **type** The type of the content (will be derived from the directory automatically if unset).<br>
**Markup** (Experimental) Specify "rst" for reStructuredText (requires **markup** (Experimental) Specify "rst" for reStructuredText (requires
`rst2html`,) or "md" (default) for the Markdown.<br> `rst2html`,) or "md" (default) for the Markdown.<br>
**Slug** The token to appear in the tail of the url.<br> **slug** The token to appear in the tail of the url.<br>
*or*<br> *or*<br>
**Url** The full path to the content from the web root.<br> **url** The full path to the content from the web root.<br>
*If neither is present the filename will be used.* *If neither is present the filename will be used.*

View File

@ -11,8 +11,8 @@ In no particular order, here is what I'm working on:
* Syntax highlighting * Syntax highlighting
* Previous & Next * Previous & Next
* Related Posts * Related Posts
* Support for TOML front matter * Support for TOML front matter -- in head
* Proper YAML support for front matter * Proper YAML support for front matter -- in head
* Support for other formats * Support for other formats

View File

@ -1,6 +1,6 @@
--- ---
Markup: 'rst' Markup: 'rst'
... ---
============== ==============