kaholaz/hello-friend-ng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Edit README

Browse source
This commit is contained in:
Djordje Atlialp 2021-04-29 23:47:03 +02:00
parent 7bc931ead2
commit 3146e3c0dd
1 changed files with 15 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -7,6 +7,7 @@
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 their great work. 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 their great work.
--- ---
## Table of Contents ## Table of Contents
- [Features](#features) - [Features](#features)
@ -17,6 +18,7 @@ This theme was highly inspired by the [hello-friend](https://github.com/panr/hug
- [image](#image) - [image](#image)
- [Code highlighting](#code-highlighting) - [Code highlighting](#code-highlighting)
- [Favicon](#favicon) - [Favicon](#favicon)
- [Audio Support](#audio-support)
- [Social Icons](#social-icons) - [Social Icons](#social-icons)
- [Known issues](#known-issues) - [Known issues](#known-issues)
- [How to edit the theme](#how-to-edit-the-theme) - [How to edit the theme](#how-to-edit-the-theme)
@ -25,18 +27,19 @@ This theme was highly inspired by the [hello-friend](https://github.com/panr/hug
- [Licence](#licence) - [Licence](#licence)
--- ---
## Features ## Features
- Theming: **dark/light mode**, depending on your system preferences - Theming: **dark/light mode**, depending on your system preferences or the users choice
- Great reading experience thanks to [**Inter UI font**](https://rsms.me/inter/), made by [Rasmus Andersson](https://rsms.me/about/) - Great reading experience thanks to [**Inter UI font**](https://rsms.me/inter/), made by [Rasmus Andersson](https://rsms.me/about/)
- Nice code highlighting thanks to [**PrismJS**](https://prismjs.com) - Nice code highlighting thanks to [**PrismJS**](https://prismjs.com)
- An easy way to modify the theme with Hugo tooling - An easy way to modify the theme with Hugo tooling
- Fully responsive - Fully responsive
- Audio support for posts (thanks to [@talbotp](https://github.com/talbotp))
- Support for social icons - Support for social icons
- Support for sharing buttons - Support for sharing buttons
- Support for [Commento](https://commento.io) - Support for [Commento](https://commento.io)
## How to start ## How to start
You can download the theme manually by going to [https://github.com/rhazdon/hugo-theme-hello-friend-ng.git](https://github.com/rhazdon/hugo-theme-hello-friend-ng.git) and pasting it to `themes/hello-friend-ng` in your root directory. You can download the theme manually by going to [https://github.com/rhazdon/hugo-theme-hello-friend-ng.git](https://github.com/rhazdon/hugo-theme-hello-friend-ng.git) and pasting it to `themes/hello-friend-ng` in your root directory.
@ -149,6 +152,16 @@ By default the theme is using PrismJS to color your code syntax. All you need to
Check the [docs](docs/favicons.md). Check the [docs](docs/favicons.md).
### Audio Support
You wrote an article and recorded it? Or do you have a special music that you would like to put on a certain article? Then you can do this now without further ado.
In your article add to your front matters part:
```yaml
audio: path/to/file.mp3
```
## Social Icons: ## Social Icons:
A large variety of social icons are available and can be configured like this: A large variety of social icons are available and can be configured like this: