summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorleafee98 <leafee98@hotmail.com>2022-05-18 14:14:53 +0800
committerleafee98 <leafee98@hotmail.com>2022-05-18 14:14:53 +0800
commit23e6e10f43145f3f5b374811851f29bf9579230a (patch)
treecf7aec2951d5341e64bd1c400c3cc02dff9780f1
parente526a8d6ca683cb90eec474778e06d88a0b20cb5 (diff)
wirte README to describe multi-section support
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5afa5ca..36585a1 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,28 @@
This is a theme I personally use.
+## Multi Section Supports
+
+If you use multi sections (with the concept from hugo), the RSS at bottom and *Recent* at side are ready for displaying those content. However, you will need to set up your menu at `config.toml` to point the hyperlink to proper destination.
+
+If you want to re-order those sections, you need a `_index.md` at the directory of the section to set proper weight at front matter, just alike what was done at the exampleSite, see `/exampleSite/content/essays/_index.md`. See the predefined variable `weight` at [docs](https://gohugo.io/content-management/front-matter/#front-matter-variables).
+
+**Note** that separating taxonomies according to different sections is not implemented yet. So better to only use taxonomies inside a specific section.
+
+For a better understand, if you have to posts *A* and *B* in section *S1* and *S2*, both of the posts has the same tag *T1*, like the follow.
+
+```
+post A: section S1, tag T1, tag T2
+post B: section S2, tag T2
+```
+
+When you open the index page of *T1*, there will be two posts, rathor than post *A* when you are in section *S1* and post *B* when you are in section *S2*.
+
+```
+tag T1: post A, post B
+tag T2: post A
+```
+
## Special Thanks
The wordpress theme [Allium](https://wordpress.org/themes/allium/), and [here](https://templatelens.com/allium/) is its home page. I like this theme very much when I'm using wordpress, but I don't have it on hugo, so I try my best to write a theme similar with it. There are many designs in this theme refers to it.