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

github.com/thomasheller/crab.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Heller <thomas.m.heller@gmail.com>2017-03-30 21:54:14 +0300
committerThomas Heller <thomas.m.heller@gmail.com>2017-03-30 21:54:14 +0300
commitcc540c726b4f5991ce1350f833587682aed730ae (patch)
tree1c75d7ddeed0f13004c1d80c12e16d6d4b2ca66f
parent4425f815d5618c08b020ede2622db1aadd09d4c3 (diff)
tags and blog explanation in README
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 340ed71..247328d 100644
--- a/README.md
+++ b/README.md
@@ -83,6 +83,36 @@ This appears in the sidebar. *Markdown* is supported!
{{% /summary %}}
```
+## Tags
+
+Tags are supported as [taxonomies described in the Hugo
+manual](https://gohugo.io/taxonomies/usage/). Make sure your config
+file contains a proper `taxonomies` declaration, like in the
+`exampleSite/config.toml`. You can then put tags in the front matter
+as usual:
+
+```
++++
+title = "A Page With Tags"
+tags = [ "Hugo", "theme", "Crab" ]
+...
+```
+
+Tags will appear both on regular (fixed, static) pages as well as for
+blog posts, although they are probably more commonly used with blog
+posts.
+
+## Blog
+
+Blog posts are intended to be created in the special directory
+`/blog/`. The main difference about blog articles is that the layout
+includes the timestamp when they were published (fixed pages don't
+show a timestamp by default) and that they appear in the list of blog
+articles.
+
+The `exampleSites/config.toml` shows the kind of `permalinks`
+declaration required to generate blog posts in the correct place.
+
## Contact
If you think anything could be improved about the Crab theme, feel