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

github.com/lxndrblz/anatole.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKenneth <schabrechts.k@gmail.com>2021-08-15 17:01:29 +0300
committerGitHub <noreply@github.com>2021-08-15 17:01:29 +0300
commitd530d03761514d90de059ca005063d447f50460c (patch)
tree9bd2f615c3e31877d737cd4e5767ec5316bcd684 /README.md
parente59100b6e4460abecc3f5ed743e72e126f76c167 (diff)
feat: Adding series to the theme
Closes #234 * Implemented basic functionality to group posts by a series * Added two example posts to display how the series work * Updated the ReadMe to include how to setup the series Co-authored-by: Alexander Bilz <mail@alexbilz.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index a37d61f..18dfa72 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,7 @@ Anatole's aims to be minimalistic and sleek but still brings some great function
- Compliant to strict CSP
- Syntax highlighting
- Uses Hugo pipes to process assets
+- Series
## Preview the exampleSite
@@ -637,6 +638,27 @@ toc = true
Please note that only "## H2 Headings" and "### H3 Headings" will appear in the table of contents.
+### Enabling Series
+
+You can enable series, which allows splitting up a huge post into a set of multiple blog posts that are still linked. This would also provide a unique link to the full series of blog posts. Each individual post in the series will also contain links to the other parts under the heading `Posts in this Series`.
+
+First, we need to enable the `series` taxonomy in the config.
+
+```toml
+[taxonomies]
+ category = "categories"
+ series = "series"
+ tag = "tags"
+```
+
+With this enabled, we can now proceed to specify the series in the Front Matter of each post of that series.
+
+```md
+series: - series-name
+```
+
+If you want to share the full series, you can do so by sharing the link `<base-url>/series/<series-name>`
+
## License
Anatole is licensed under the [MIT license](https://github.com/lxndrblz/anatole/blob/master/LICENSE).