Updated README and Licence

This commit is contained in:
nono
2021-05-15 14:05:49 +02:00
parent 274b1c55ef
commit d8d428824e
2 changed files with 680 additions and 20 deletions

View File

@@ -1,6 +1,8 @@
# blogotheme
The theme for my blog, used by the Hugo static website generator. It's based on the design of newspapers, brutalist web design, and inspired by the solar website built by low tech magazine.
![](cover.png)
## Features
- It's **Fast**! PageSpeed scores consistently between 94-100
@@ -14,10 +16,11 @@ The theme for my blog, used by the Hugo static website generator. It's based on
## Installation
In the root directory of your Hugo Project, clone the repo into the themes directory.
```shell session
git clone TODO themes/blogotheme
git clone http://git.n07070.xyz/n07070/blogotheme.git themes/blogotheme
```
## Usage
@@ -98,7 +101,7 @@ The `dropCap` parameter is used to determine if the first letter of a post shoul
Add an interesting description and a good image to each post to get the most value from this theme.
Aether takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site. This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/). Use the `image` and `smallimg` shortcodes to take full advantage of image optimization. Also, the `featuredImage` resource must exist in the post's page bundle.
Blogotheme takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site. This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/). Use the `image` and `smallimg` shortcodes to take full advantage of image optimization. Also, the `featuredImage` resource must exist in the post's page bundle.
Posts are written in markdown. You can find how to write in markdown from this [markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
@@ -146,7 +149,7 @@ You can add optional Open Graph, Twitter, or other meta tags by adding `project_
Refer to [/exampleSite/layouts/partials](/exampleSite/layouts/partials) for sample meta configs.
## Helpful Links
[Aether Blog Post](https://www.joehutch.com/posts/blogotheme-theme/) - See blogotheme in action and learn more about the theme
[Blogotheme in action](https://n07070.xyz) - See blogotheme in action and learn more about the theme
[Hugo Documentation](https://gohugo.io/documentation/) - Learn how to use Hugo
@@ -158,4 +161,6 @@ Refer to [/exampleSite/layouts/partials](/exampleSite/layouts/partials) for samp
I welcome you to help make it better! Contributions in the way of new features, documentation improvements, bug fixes, and feature requests are appreciated. Please make an individual pull-request/issue for each suggestion.
## License
AGPLV - N07070
AGPLV3 - N07070
Based on the Aether Theme