From 0c2544608cfae1e272da252c383c8fa72634eed7 Mon Sep 17 00:00:00 2001 From: spf13 Date: Thu, 29 May 2014 01:00:06 -0400 Subject: [PATCH] Add future details to documentation --- docs/content/content/front-matter.md | 6 ++++-- docs/content/meta/release-notes.md | 1 + docs/content/overview/usage.md | 5 +++-- docs/content/templates/variables.md | 3 ++- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/content/content/front-matter.md b/docs/content/content/front-matter.md index eec83df9b..031927967 100644 --- a/docs/content/content/front-matter.md +++ b/docs/content/content/front-matter.md @@ -75,13 +75,15 @@ any variable they want to. These will be placed into the `.Params` variable avai * **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) +* **taxonomies** These will use the field name of the plural form of the index (see tags and categories above) ### Optional * **redirect** Mark the post as a redirect post -* **draft** If true the content will not be rendered unless hugo is called with --build-drafts +* **draft** If true the content will not be rendered unless hugo is called with --buildDrafts +* **publishdate** If in the future, content will not be rendered unless hugo is called with --buildFuture * **type** The type of the content (will be derived from the directory automatically if unset) +* **weight** Used for sorting * **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 diff --git a/docs/content/meta/release-notes.md b/docs/content/meta/release-notes.md index 37c7e953b..5d29dea4b 100644 --- a/docs/content/meta/release-notes.md +++ b/docs/content/meta/release-notes.md @@ -18,6 +18,7 @@ menu: * [Integrated Disqus](/extras/comments) support * Streamlined [template organization](/templates/overview) * [Brand new docs site](http://hugo.spf13.com) + * Support for publishDate which allows for posts to be dated in the future * More [sort](/content/ordering) options * Logging support * Much better error handling diff --git a/docs/content/overview/usage.md b/docs/content/overview/usage.md index 52a09b2dc..38df28f05 100644 --- a/docs/content/overview/usage.md +++ b/docs/content/overview/usage.md @@ -35,7 +35,8 @@ Make sure either hugo is in your path or provide a path to it. Available Flags: -b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/ - -D, --buildDrafts=false: include content marked as draft + -D, --buildDrafts=false: build content marked as draft + -F, --buildFuture=false: build content with PublishDate in the future --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS=false: Do not build RSS files @@ -74,7 +75,7 @@ is saved. Press ctrl+c to stop Hugo can even run a server and create your site at the same time! Hugo -implements live reload technology to automatically reload any open pages in +implements [live reload](/extras/livereload) technology to automatically reload any open pages in all browsers (including mobile). $ hugo server -ws ~/mysite diff --git a/docs/content/templates/variables.md b/docs/content/templates/variables.md index 88fb5950e..b64c7989d 100644 --- a/docs/content/templates/variables.md +++ b/docs/content/templates/variables.md @@ -25,7 +25,8 @@ matter, content or derived from file location. **.Summary** A generated summary of the content for easily showing a snippet in a summary view.
**.Description** The description for the content.
**.Keywords** The meta keywords for this content.
-**.Date** The date the content is published on.
+**.Date** The date the content is associated with.
+**.PublishDate** The date the content is published on.
**.Type** The content [type](/content/types/) (eg. post)
**.Section** The [section](/content/sections/) this content belongs to
**.Permalink** The Permanent link for this page.