fliegerjohn/smolsite
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update Readme

Browse source
This commit is contained in:
Fliegerjohn 2024-11-01 10:41:32 +01:00
parent eef539a20e
commit 874809c588
Signed by: fliegerjohn
GPG key ID: E2221D5FE4656B6A
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,6 @@
# smol # smol
A minimal, monospaced blogging theme for Hugo that respects your privacy and is easy on your bandwidth. A demo can be found at https://smol-demo.morph.sh. A minimal, monospaced blogging theme for Hugo that respects your privacy and is easy on your bandwidth.
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).
@ -19,7 +19,7 @@ smol is based on [Blank](https://github.com/Vimux/Blank) created by [Vimux](http
In your Hugo site `themes` directory, run: In your Hugo site `themes` directory, run:
``` ```
git clone https://github.com/colorchestra/smol git clone https://git.datenkastl.org/fliegerjohn/smol.git
``` ```
Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `smol`. Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `smol`.
@ -85,8 +85,13 @@ You can add captions to images (technically using `<figcaption>` HTML tags) by a
## Contributing ## Contributing
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). 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/smol/issues)to let me know. Or make directly a [pull request](https://git.datenkastl.org/fliegerjohn/smol/pulls).
## License ## License
This theme is released under the [MIT license](https://github.com/colorchestra/smol/blob/master/LICENSE). This theme is released under the [MIT license](https://git.datenkastl.org/fliegerjohn/smol/raw/branch/master/LICENSE.md).
## Acknowledgements
Smol - [colorchestra](https://github.com/colorchestra/smol)