Add future details to documentation

This commit is contained in:
spf13 2014-05-29 01:00:06 -04:00
parent c502f078bc
commit 0c2544608c
4 changed files with 10 additions and 5 deletions

View file

@ -75,13 +75,15 @@ any variable they want to. These will be placed into the `.Params` variable avai
* **title** The title for the content * **title** The title for the content
* **description** The description for the content * **description** The description for the content
* **date** The date the content will be sorted by * **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 ### Optional
* **redirect** Mark the post as a redirect post * **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) * **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 * **markup** (Experimental) Specify "rst" for reStructuredText (requires
`rst2html`,) or "md" (default) for the Markdown `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

View file

@ -18,6 +18,7 @@ menu:
* [Integrated Disqus](/extras/comments) support * [Integrated Disqus](/extras/comments) support
* Streamlined [template organization](/templates/overview) * Streamlined [template organization](/templates/overview)
* [Brand new docs site](http://hugo.spf13.com) * [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 * More [sort](/content/ordering) options
* Logging support * Logging support
* Much better error handling * Much better error handling

View file

@ -35,7 +35,8 @@ Make sure either hugo is in your path or provide a path to it.
Available Flags: Available Flags:
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/ -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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS=false: Do not build RSS files --disableRSS=false: Do not build RSS files
@ -74,7 +75,7 @@ is saved.
Press ctrl+c to stop Press ctrl+c to stop
Hugo can even run a server and create your site at the same time! Hugo 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). all browsers (including mobile).
$ hugo server -ws ~/mysite $ hugo server -ws ~/mysite

View file

@ -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.<br> **.Summary** A generated summary of the content for easily showing a snippet in a summary view.<br>
**.Description** The description for the content.<br> **.Description** The description for the content.<br>
**.Keywords** The meta keywords for this content.<br> **.Keywords** The meta keywords for this content.<br>
**.Date** The date the content is published on.<br> **.Date** The date the content is associated with.<br>
**.PublishDate** The date the content is published on.<br>
**.Type** The content [type](/content/types/) (eg. post)<br> **.Type** The content [type](/content/types/) (eg. post)<br>
**.Section** The [section](/content/sections/) this content belongs to<br> **.Section** The [section](/content/sections/) this content belongs to<br>
**.Permalink** The Permanent link for this page.<br> **.Permalink** The Permanent link for this page.<br>