ptrcnull/smol
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update readme and license

Browse source
This commit is contained in:
morph 2020-05-27 02:10:24 +02:00
parent 2b09fc88e0
commit 6cbd464175
3 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
LICENSE → LICENSE.md
View file

12
README.md
View file

@ -1,14 +1,19 @@
# smol # smol
A minimal Hugo theme that respects your privacy and is easy on your bandwidth. A minimal, monospaced blogging theme for Hugo that respects your privacy and is easy on your bandwidth.
A real-life example can be found at https://morph.sh.
smol is based on [Blank](https://github.com/Vimux/Blank) created by [Vimux](https://github.com/Vimux). smol is based on [Blank](https://github.com/Vimux/Blank) created by [Vimux](https://github.com/Vimux).
![Screenshot](/images/tn.png)
## Features ## Features
- No JavaScript - No JavaScript
- No Google spyware or tracking of any kind - No Google spyware or tracking of any kind
- No other external dependencies - No other external dependencies, embedded fonts or comment sections
- Dark mode support (depending on your OS's setting) - Dark mode support (depending on your OS's setting)
## Installation ## Installation
@ -25,7 +30,7 @@ Next, open `config.toml` in the base of the Hugo site and ensure the theme optio
theme = "smol" theme = "smol"
``` ```
Lastly, add the following lines to your `config.toml` to make use of all the menu entries in the header and the footer if you need them. Lastly, add the following lines to your `config.toml` to make use of all the menu entries in the header and footer sections if you need them.
``` ```
# Header # Header
@ -66,7 +71,6 @@ Lastly, add the following lines to your `config.toml` to make use of all the men
``` ```
For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo. For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo.
## Contributing ## Contributing

2
theme.toml
View file

@ -1,6 +1,6 @@
name = "smol" name = "smol"
license = "MIT" license = "MIT"
licenselink = "https://github.com/colorchestra/smol/blob/master/LICENSE" licenselink = "https://github.com/colorchestra/smol/blob/master/LICENSE.md"
description = "Minimal Hugo theme using a Monospace font and without any tracking or external dependencies." description = "Minimal Hugo theme using a Monospace font and without any tracking or external dependencies."
homepage = "https://github.com/colorchestra/smol" homepage = "https://github.com/colorchestra/smol"
tags = ["blog", "minimal", "monospace", "dark mode", "simple", "clean", "light", "responsive", "fast", "no-js", "no-tracking", "privacy"] tags = ["blog", "minimal", "monospace", "dark mode", "simple", "clean", "light", "responsive", "fast", "no-js", "no-tracking", "privacy"]