histausse/hugo-theme-hello-friend
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Radek Kozieł 2019-03-06 01:16:57 +01:00 committed by GitHub
parent f7e16f680f
commit be730d5c28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -8,6 +8,20 @@ This theme is pretty basic and covers all of the essentials. All you have to do
### DEMO - https://hugo-hello-friend.now.sh/ ### DEMO - https://hugo-hello-friend.now.sh/
---
- [Features](#features)
- [Built-in shortcodes](#built-in-shortcodes)
- [Code highlighting](#code-highlighting)
- [How to start](#how-to-start)
- [How to configure](#how-to-configure)
- [Add-ons](#add-ons)
- [How to run your site](#how-to-run-your-site)
- [How to edit the theme](#how-to-edit-the-theme)
- [How to contribute](#how-to-contribute)
- [Terminal theme user?](#terminal-theme-user)
- [Licence](#licence)
## Features ## Features
- **dark/light mode**, depending on your preferences (dark is default, but you can change it) - **dark/light mode**, depending on your preferences (dark is default, but you can change it)
@ -107,6 +121,10 @@ to `config.toml` file in your Hugo root directory and change params fields. In c
**NOTE:** Please keep in mind that currently main menu doesn't support nesting. **NOTE:** Please keep in mind that currently main menu doesn't support nesting.
## Add-ons
- **Comments** — for adding comments to your blog posts please take a look at `layouts/partials/comments.html` https://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/comments.html.
## How to run your site ## How to run your site
From your Hugo root directory run: From your Hugo root directory run:
@ -139,6 +157,10 @@ $ yarn
If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-theme-hello-friend/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/panr/hugo-theme-hello-friend/pulls). If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-theme-hello-friend/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/panr/hugo-theme-hello-friend/pulls).
## `Hello friend` theme user?
I'd be happy to know more about you and what you are doing. If you want to share it, please make a contribution and [add your site to the list](https://github.com/panr/hugo-theme-hello-friend/blob/master/USERS.md)! 🤗
## Licence ## Licence
Copyright © 2019 Radosław Kozieł ([@panr](https://twitter.com/panr)) Copyright © 2019 Radosław Kozieł ([@panr](https://twitter.com/panr))