Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/kakawait/hugo-tranquilpeak-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEric Bouchut <ebouchut@gmail.com>2017-01-15 23:33:36 +0300
committerEric Bouchut <ebouchut@gmail.com>2017-01-15 23:40:22 +0300
commit511cd27ef994763cf885adbce48a2fde7d5409fe (patch)
tree5b440ee5fa0cb14dad3233841b9cd5a5bc9eb584 /docs
parent4ebe2b0852f1463d8d0de4714ccecb89e5baccc7 (diff)
Feature #106: Add documentation for page archetype
Diffstat (limited to 'docs')
-rw-r--r--docs/user.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/user.md b/docs/user.md
index aa7a550..6975c16 100644
--- a/docs/user.md
+++ b/docs/user.md
@@ -47,6 +47,7 @@ If you want to report a bug or ask a question, [create an issue](https://github.
* [Tabbed code block](#tabbed-code-block)
* [Wide image](#wide-image)
* [Fancybox](#fancybox)
+- [Writing pages](#writing-pages)
- [Running](#running)
## General
@@ -662,6 +663,48 @@ E.g:
|src|Path to the original image.|
|title (optional)|Title of image displayed in a caption under image. `Alt` HTML attribute will use this title. E.g : `"A beautiful sunrise"`.|
+
+## Writing pages ##
+
+Sometimes you need to create a **page** that is **not** a **regular blog post**,
+where you want to hide the date, social sharing buttons, tags, categories
+and pagination.
+This is the case for the blog pages _About_ or _Contact_ for instance which do
+not need to be timestamped (nor tagged or categorized) nor provide
+pagination and are not intended to be shared on social networks.
+
+In order to create such a page you can proceed like so:
+
+```
+hugo new page/contact.md
+```
+
+This creates the file `contact.md` in the directory `content/page`
+pre-populated with the following front matter.
+
+```yaml
+---
+title: "New Page"
+categories:
+- category
+- subcategory
+tags:
+- tag1
+- tag2
+keywords:
+- tech
+comments: false
+showDate: false
+showSocial: false
+showTags: false
+showPagination: false
+#thumbnailImage: //example.com/image.jpg
+---
+
+```
+
+The rest is basically the same as for a regular _[post](#writing-post)_.
+
## Running ##
Run `hugo server` and start writing! :)