path: root/README.md
diff options
authorAdam Mathes <adam@trenchant.org>2017-04-16 12:14:01 -0700
committerAdam Mathes <adam@trenchant.org>2017-04-16 12:14:01 -0700
commit3f06277f3df483c2c7b5e0441998139a9570f088 (patch)
tree653970bed119f2de233b339aaa65ab39d92cf4b2 /README.md
parentaee32aafdfe313be5b5fff21866e4bd562a7e545 (diff)
readme updated with basic tags support
Diffstat (limited to 'README.md')
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index bc2caf2..6a0029d 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,6 @@ It powers [trenchant.org](https://trenchant.org) but is under active development
[Install Go](https://golang.org/doc/install)
Set up $GOPATH
$ mkdir $HOME/go
@@ -270,6 +269,25 @@ filters:
r: "http://www.amazon.com/exec/obidos/ASIN/$1/decommodify-20/"
+### tags
+There is preliminary support for tag style metadata per post.
+Add a "tags" field to your post preamble. Tags should be comma separated.
+ tags: TagOne, tag two, a third tag, fourth
+Tags will be normalized to lowercase, with spaces replaced with underscores. So the above would have tagged a post with --
+`tagone tag_two a_third_tag fourth`
+Tags are accessible in each post struct via the `Tags` field.
+To create archives of tags, create a template named `tags` -- it will behave the same as an `archive` template, but create a file at HTML_DIR/tag/tag_name/index.html for each unique tag.
### Example configurations/sites/themes
*not done*