raghnarok/hugo-snotra
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

[THEME] Improve README

Browse source
This commit is contained in:
Gregory Trolliet 2020-04-28 21:50:23 +02:00
parent f3b542693d
commit 429d024f78
1 changed files with 42 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
README.md
View file

@ -24,7 +24,18 @@ baseurl = "https://yourdoma.in" # The base url of your Hugo website
title = "Title" # The title of your website title = "Title" # The title of your website
author = "Author" # The author of the website author = "Author" # The author of the website
language = "fr" language = "fr"
theme = "idunn" # The Hugo theme theme = "snotra" # The Hugo theme
```
### Menu
The menu is generated following all the files in the root directory
and the articles in the *blog* directory.
To avoid the *blog* entry to be pluralized,
add the following option to your config file:
```toml
pluralizeListTitles = false
``` ```
### Description ### Description
@ -36,18 +47,31 @@ You can use some parameters to fill meta tags and bases images:
description = "" # Description for the meta tag description = "" # Description for the meta tag
favicon = "" # Favicon URL favicon = "" # Favicon URL
logo = "" # Logo URL logo = "" # Logo URL
keyword = "" # Keywords for the meta tag
``` ```
### Colors ### Home page
It is possible to basicaly change some colors: The home page use one avatar, the name, one description and a list of social
networks.
For the social networks, see *Social Networks* chapter.
```toml ```toml
[params.colors] [params]
font = "black" # General font color, default to black author = "Author" # The author of the website
background = "white" # General background color, default to white info = "Your infos" # Displayed under author name
main = "grey" # Theme color, used for footer among others, default to grey avatar = "file.png" # Placed in static/images
font_above = "white" # Used for font above *main* color, default to white ```
### Twitter:card
Twitter cards are automaticly generated.
If you want tho have the twitter:site meta generated,
add the following option to your config file:
```toml
[params]
twitterUser = "youruser" # Your Twitter account without @
``` ```
### Custom CSS ### Custom CSS
@ -57,38 +81,18 @@ It is possible to basicaly change some colors:
custom_css = ["style.css"] # Your own css files custom_css = ["style.css"] # Your own css files
``` ```
### Contact footer
If you want to have some informations about you in the footer,
you can set it with thoses parameters:
```toml
[params.contact]
email = "mail@serve.ur" # The mail of your company
phone = "+41 22 123 45 67" # The phone number of your company
address = "Your address" # The address of your company
```
### Social Networks ### Social Networks
You can also set some of your networks accounts. You can also set some of your networks accounts to display on the home page.
Thoses options are availables: Every social network (or not so network) have to be described with thoses
options:
```toml ```toml
[params.social] [[params.social]]
500px = "" name = "Title of the entry" # Title, used on hover
codepen = "" icon = "facebook" # Icon to use
facebook = "" weight = 1 # Sort order
flickr = "" url = "https://www.facebook.com/user" # Link to your account
github = ""
gitlab = ""
instagram = ""
linkedin = ""
mastodon = ""
peertube = ""
pinterest = ""
pixelfed = ""
tumblr = ""
twitter = ""
youtube = ""
``` ```
You can also add some non social elements, you only need to have an icon.