diff options
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md index dd22633..5d18892 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,43 @@ Hugo theme, using [readable.css][readable] for ease of reading. [readable]: https://readable-css.freedomtowrite.org/ +## Usage + +### Adding theme + +If you use git for managing your content, adding it as a submodule is +straightforward: + +```sh +git submodule add https://git.sr.ht/~huyngo/victor themes/victor +``` + +Then add it in the config: + +```toml +theme = 'victor' +``` + +### Use for blog + +You should add `blog` to the list of categories of the section to get +reverse-chronological feed. RSS feed is currently not tested. + +### Use for book + +You should add `book` to the list of categories for every section of the book +to get recursive table of content and breadcrumb navigation. Bread crumb is +generated from the current page up to the furthest ancestor section that is a +book, so you have to add that for *every* section of the book. If your site +consists of only book, you can set a theme-specific parameter to note that: + +```toml +[params] +OnlyBooks = true +``` + +RSS feed is currently not tested. + ## Licenses This theme is released under MIT license. Full license text can be found in |