97 lines
2.5 KiB
Markdown
97 lines
2.5 KiB
Markdown
# smolsite
|
|
|
|
A minimal, monospaced site theme for Hugo that respects your privacy and is easy on your bandwidth.
|
|
|
|
smolsite is based on [Smol](https://git.datenkastl.org/fliegerjohn/smol).
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- No JavaScript
|
|
- No Google spyware or tracking of any kind
|
|
- No other external dependencies, embedded fonts or comment sections
|
|
- Dark mode support (depending on your OS's setting)
|
|
|
|
## Installation
|
|
|
|
In your Hugo site `themes` directory, run:
|
|
|
|
```
|
|
git clone https://git.datenkastl.org/fliegerjohn/smolsite.git
|
|
```
|
|
|
|
Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `smolsite`.
|
|
|
|
```
|
|
theme = "smolsite"
|
|
```
|
|
|
|
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.
|
|
|
|
```
|
|
# Parameters
|
|
[params]
|
|
subtitle = "Your blog subtitle goes here!"
|
|
dateFmt = "02.01.2006 15:04"
|
|
|
|
# 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"
|
|
url = "https://github.com/example"
|
|
weight = 1
|
|
|
|
[[menu.footer]]
|
|
name = "Mastodon"
|
|
url = "https://example.com/@user"
|
|
weight = 2
|
|
|
|
[[menu.footer]]
|
|
name = "Imprint"
|
|
url = "/imprint"
|
|
weight = 3
|
|
|
|
```
|
|
|
|
For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo.
|
|
|
|
## Optional features
|
|
### Custom copyright text
|
|
Add `copyright = "Your text here"` - in the config.toml to change the copyright notice in the footer.
|
|
|
|
### Image captions
|
|
You can add captions to images (technically using `<figcaption>` HTML tags) by adding titles, like so: ``
|
|
|
|
## Contributing
|
|
|
|
Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://git.datenkastl.org/fliegerjohn/smolsite/issues)to let me know. Or make directly a [pull request](https://git.datenkastl.org/fliegerjohn/smolsite/pulls).
|
|
|
|
## License
|
|
|
|
This theme is released under the [MIT license](https://git.datenkastl.org/fliegerjohn/smolsite/raw/branch/master/LICENSE.md).
|
|
|
|
|
|
## Acknowledgements
|
|
|
|
Smol - [colorchestra](https://github.com/colorchestra/smol)
|