Add changelog
This commit is contained in:
parent
9f3c15b70e
commit
5a0d4c1c3f
2 changed files with 35 additions and 2 deletions
14
CHANGELOG.md
Normal file
14
CHANGELOG.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## 2020-05-13
|
||||
|
||||
### Added
|
||||
- Changelog
|
||||
|
||||
### Changed
|
||||
- In order to make the image handling more consistent, the `cover` tag does not force the image to live in `/img/` anymore. [!131](https://github.com/rhazdon/hugo-theme-hello-friend-ng/pull/131).
|
23
README.md
23
README.md
|
@ -6,6 +6,25 @@
|
|||
|
||||
This theme was highly inspired by the [hello-friend](https://github.com/panr/hugo-theme-hello-friend) and [hermit](https://github.com/Track3/hermit). A lot of kudos for theier great work.
|
||||
|
||||
---
|
||||
## Table of Contents
|
||||
|
||||
- [Features](#features)
|
||||
- [How to start](#how-to-start)
|
||||
- [How to configure](#how-to-configure)
|
||||
- [More](#more-things)
|
||||
- [Built in shortcodes](#built-in-shortcodes)
|
||||
- [image](#image)
|
||||
- [Code highlighting](#code-highlighting)
|
||||
- [Favicon](#favicon)
|
||||
- [Social Icons](#social-icons)
|
||||
- [Known issues](#known-issues)
|
||||
- [How to edit the theme](#how-to-edit-the-theme)
|
||||
- [Changelog](CHANGELOG.md)
|
||||
- [Sponsoring](#sponsoring)
|
||||
- [Licence](#licence)
|
||||
|
||||
---
|
||||
## Features
|
||||
|
||||
- Theming: **dark/light mode**, depending on your preferences (dark is default, but you can change it)
|
||||
|
@ -101,7 +120,7 @@ paginate = 10
|
|||
|
||||
Of course you are able to use all default shortcodes from hugo (https://gohugo.io/content-management/shortcodes/).
|
||||
|
||||
#### `image`
|
||||
#### image
|
||||
|
||||
Properties:
|
||||
|
||||
|
@ -132,7 +151,7 @@ By default the theme is using PrismJS to color your code syntax. All you need to
|
|||
|
||||
Check the [docs](docs/favicons.md).
|
||||
|
||||
## Available Social Icons:
|
||||
## Social Icons:
|
||||
|
||||
Take a look into this [list](docs/svgs.md)
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue