Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/colorchestra/smol.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormorph <morph@posteo.de>2020-05-27 03:10:24 +0300
committermorph <morph@posteo.de>2020-05-27 03:10:24 +0300
commit6cbd46417531a703c69518e50ed2f7186b4e0a84 (patch)
tree0c5e92481fa614a97a0299ffeea7deb61aa6adda
parent2b09fc88e09a273328618fc384208cc48bf1138c (diff)
update readme and license
-rw-r--r--LICENSE.md (renamed from LICENSE)0
-rw-r--r--README.md12
-rw-r--r--theme.toml2
3 files changed, 9 insertions, 5 deletions
diff --git a/LICENSE b/LICENSE.md
index 5b7718c..5b7718c 100644
--- a/LICENSE
+++ b/LICENSE.md
diff --git a/README.md b/README.md
index 6665aed..5cf59db 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,19 @@
# 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).
+
+![Screenshot](/images/tn.png)
+
## Features
- No JavaScript
- 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)
## Installation
@@ -25,7 +30,7 @@ Next, open `config.toml` in the base of the Hugo site and ensure the theme optio
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
@@ -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.
## Contributing
diff --git a/theme.toml b/theme.toml
index 9841c69..318f26c 100644
--- a/theme.toml
+++ b/theme.toml
@@ -1,6 +1,6 @@
name = "smol"
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."
homepage = "https://github.com/colorchestra/smol"
tags = ["blog", "minimal", "monospace", "dark mode", "simple", "clean", "light", "responsive", "fast", "no-js", "no-tracking", "privacy"]