tlwiki-hugo-theme/README.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

# Thurstylark Wiki Hugo Theme
2021-03-05 09:44:42 +00:00
The style and layout for [Thurstylark's Wiki](https://wiki.thurstylark.com/).
2021-03-05 09:44:42 +00:00
A fork of [risotto](https://github.com/joeroe/risotto).
2021-03-05 09:44:42 +00:00
## Install
The easiest way to install the theme is to clone this repository into your site's `themes` directory:
2021-03-05 09:44:42 +00:00
```shell
git clone https://git.thurstylark.com/thurstylark/tlwiki-hugo-theme.git
2021-03-05 09:44:42 +00:00
```
If your site is already a git repository, you can add the theme as a submodule instead:
2021-03-05 09:44:42 +00:00
```shell
git submodule add https://git.thurstylark.com/thurstylark/tlwiki-hugo-theme.git
```
## Configure
To use the theme, add `theme = tlwiki-hugo-theme` to your site's `config.toml` or `config.yaml`.
2021-03-05 09:44:42 +00:00
See `exampleSite/config.toml` for the theme-specific parameters you need to add to your site's `config.toml` or `config.yaml` to configure the theme.
## Update
2021-03-05 09:44:42 +00:00
If you installed the theme using `git clone`, pull the repository to get the latest version:
2021-03-05 09:44:42 +00:00
```shell
cd themes/tlwiki-hugo-theme
2021-03-05 09:44:42 +00:00
git pull
```
Or, if you added it as a git submodule:
```shell
git submodule update --remote
```
2021-03-05 09:44:42 +00:00
## License
See: [./LICENSE](./LICENSE)
TL;DR: MIT. go nuts.