2020-05-26 16:13:01 +00:00
# smol
2016-10-14 20:41:10 +00:00
2020-11-24 17:58:57 +00:00
> Forked by ptrcnull to make some customizations
2020-05-27 00:10:24 +00:00
A minimal, monospaced blogging theme for Hugo that respects your privacy and is easy on your bandwidth.
2020-11-24 18:01:04 +00:00
A real-life example can be found at https://ptrcnull.me.
2020-05-26 23:12:45 +00:00
2020-05-26 23:21:24 +00:00
smol is based on [Blank ](https://github.com/Vimux/Blank ) created by [Vimux ](https://github.com/Vimux ).
2016-10-14 20:41:10 +00:00
2020-05-27 00:10:24 +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
2020-05-27 00:10:24 +00:00
- No other external dependencies, embedded fonts or comment sections
2016-10-14 20:41:10 +00:00
## Installation
In your Hugo site `themes` directory, run:
```
2021-11-17 22:55:14 +00:00
git clone https://github.com/ptrcnull/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
```
2020-08-04 11:33:15 +00:00
Lastly, add the following lines to your `config.toml` to set site parameters and make use of all the menu entries in the header and footer sections if you need them.
2020-05-26 23:21:24 +00:00
```
2020-08-04 11:33:15 +00:00
# Parameters
[params]
subtitle = "Your blog subtitle goes here!"
dateFmt = "02.01.2006 15:04"
2020-05-26 23:21:24 +00:00
# Header
[menu]
[[menu.main]]
identifier = "posts"
name = "Posts"
url = "/posts/"
weight = 1
[[menu.main]]
identifier = "categories"
name = "Categories"
url = "/categories/"
weight = 2
[[menu.main]]
identifier = "tags"
name = "Tags"
url = "/tags/"
weight = 3
# Footer
[[menu.footer]]
name = "Github"
2020-06-04 15:56:14 +00:00
url = "https://github.com/example"
2020-05-26 23:21:24 +00:00
weight = 1
[[menu.footer]]
name = "Mastodon"
2020-06-04 15:56:14 +00:00
url = "https://example.com/@user"
2020-05-26 23:21:24 +00:00
weight = 2
[[menu.footer]]
name = "Imprint"
url = "/imprint"
weight = 3
```
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 ).
