smol/README.md

35 lines
1,008 B
Markdown
Raw Normal View History

2020-05-26 16:13:01 +00:00
# smol
2016-10-14 20:41:10 +00:00
2020-05-26 16:13:01 +00:00
A minimal Hugo theme based on [Blank](https://github.com/Vimux/Blank) using a Monospace font and not much else.
2016-10-14 20:41:10 +00:00
2020-05-26 16:13:01 +00:00
## Features
2016-12-19 15:45:49 +00:00
2020-05-26 16:13:01 +00:00
- No JavaScript
- No Google spyware or tracking of any kind
- No other external dependencies
- Dark mode support (depending on your OS's setting)
2016-10-14 20:41:10 +00:00
## Installation
In your Hugo site `themes` directory, run:
```
2020-05-26 16:13:01 +00:00
git clone https://github.com/colorchestra/smol
2016-10-14 20:41:10 +00:00
```
2020-05-26 16:13:01 +00:00
Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `smol`.
2016-10-14 20:41:10 +00:00
```
2020-05-26 16:13:01 +00:00
theme = "smol"
2016-10-14 20:41:10 +00:00
```
2019-07-29 20:21:21 +00:00
For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo.
2016-10-14 20:41:10 +00:00
## Contributing
2020-05-26 16:13:01 +00:00
Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/colorchestra/smol/issues) to let me know. Or make directly a [pull request](https://github.com/colorchestra/smol/pulls).
2016-10-14 20:41:10 +00:00
## License
2020-05-26 16:13:01 +00:00
This theme is released under the [MIT license](https://github.com/colorchestra/smol/blob/master/LICENSE).