From 1159b69c669a124171f8350f73e8ef123551b73e Mon Sep 17 00:00:00 2001 From: spf13 Date: Mon, 8 Jul 2013 22:23:54 -0400 Subject: [PATCH] Adding support for TOML, updating documentation --- content/doc/contributors.md | 2 +- content/doc/example.md | 2 +- content/doc/front-matter.md | 79 +++++++++++++++++++++++++++---------- content/doc/roadmap.md | 4 +- content/doc/rst.rst | 2 +- 5 files changed, 64 insertions(+), 25 deletions(-) diff --git a/content/doc/contributors.md b/content/doc/contributors.md index 3a7d7e647..4bc5a9d31 100644 --- a/content/doc/contributors.md +++ b/content/doc/contributors.md @@ -1,6 +1,6 @@ --- title: "Contributors" -Pubdate: "2013-07-01" +date: "2013-07-01" --- Hugo was built with love and golang by: diff --git a/content/doc/example.md b/content/doc/example.md index ab409c595..51e3c160e 100644 --- a/content/doc/example.md +++ b/content/doc/example.md @@ -16,7 +16,7 @@ Somethings are better shown than explained. The following is a very basic exampl 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 e4342099f..0fb03b443 100644 --- a/content/doc/front-matter.md +++ b/content/doc/front-matter.md @@ -1,43 +1,82 @@ ---- -title: "Front Matter" -Pubdate: "2013-07-01" ---- ++++ +title = "Front Matter" +date = "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 YAML. Here is an example: +different formats each with their own identifying tokens. + +Supported formats:
+ **YAML**, identified by '\-\-\-'.
+ **TOML**, indentified with '+++'.
+ **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" - 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: + 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" + 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 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. +**Field names are case insensitive.** #### Required -**Title** The title for the content.
-**Description** The description for the content.
-**Pubdate** The date the content will be sorted by.
-**Indexes** These will use the field name of the plural form of the index (see tags and categories above) +**title** The title for the content.
+**description** The description for the content.
+**date** The date the content will be sorted by.
+**indexes** These will use the field name of the plural form of the index (see tags and categories above) #### Optional -**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 +**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.
+**slug** The token to appear in the tail of the url.
*or*
-**Url** The full path to the content from the web root.
+**url** The full path to the content from the web root.
*If neither is present the filename will be used.* diff --git a/content/doc/roadmap.md b/content/doc/roadmap.md index 93a7a83d4..1db9f2d79 100644 --- a/content/doc/roadmap.md +++ b/content/doc/roadmap.md @@ -11,8 +11,8 @@ In no particular order, here is what I'm working on: * Syntax highlighting * Previous & Next * Related Posts - * Support for TOML front matter - * Proper YAML support for front matter + * Support for TOML front matter -- in head + * Proper YAML support for front matter -- in head * Support for other formats diff --git a/content/doc/rst.rst b/content/doc/rst.rst index c2838eb0a..37e1357cb 100644 --- a/content/doc/rst.rst +++ b/content/doc/rst.rst @@ -1,6 +1,6 @@ --- Markup: 'rst' -... +--- ==============