# Victor theme

> To my surprise, no one has created a Hugo theme called Victor
> 
> -- me, at some point

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
`LICENSES/MIT.txt`.

The theme uses CSS style from [readable.css][readable], written by Freedom to
Write project and licensed under 0BSD license.