summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Shpak <alex-shpak@users.noreply.github.com>2020-01-24 00:07:47 +0100
committerAlex Shpak <alex-shpak@users.noreply.github.com>2020-01-24 00:07:56 +0100
commitba5d38ad4427bcda21a4cc57689464ed58d8b9a0 (patch)
tree12964eb240f749baa7276369265c89a04765d14e /README.md
parent2acd6ab280390057bf6d68a801a1be0f09dbd0b9 (diff)
Rework of main template, adds options for more fine customisation
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index f872c53..5ad9a19 100644
--- a/README.md
+++ b/README.md
@@ -200,7 +200,7 @@ bookCollapseSection = true
bookHidden = true
# (Optional) Set how many levels of ToC to show. use 'false' to hide ToC completely
-bookToC = 3
+bookToC = true
# (Optional) If you have enabled BookComments for the site, you can disable it for specific pages.
bookComments = true
@@ -329,6 +329,12 @@ x = \begin{cases}
{{< /katex >}}
```
+## Versioning
+
+Theme follows simple incremental versioning. e.g. `v1`, `v2` and so on. There might be breaking changes between versions.
+
+If you want lower maintenance use one of released versions. If you want to live on the edge of changes you can use `master` branch and update your website when needed.
+
## Contributing
### [Extra credits to contributors](https://github.com/alex-shpak/hugo-book/graphs/contributors)