hugo-snotra/README.md

104 lines
2.5 KiB
Markdown
Raw Normal View History

2020-04-28 12:26:34 +02:00
# Hugo theme : Snotra
This is a dark and classy Hugo theme.
## Installation
To install Simple-site theme, you can simply clone the repository
to your site's theme directory.
```bash
$ mkdir themes
$ cd themes
$ git clone https://git.vulgarisons.info/raghnarok/hugo_snotra.git snotra
```
Don't forget to change the theme in your config.toml file.
## Configuration
### Base
```toml
baseurl = "https://yourdoma.in" # The base url of your Hugo website
title = "Title" # The title of your website
author = "Author" # The author of the website
language = "fr"
2020-04-28 21:50:23 +02:00
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
2020-04-28 12:26:34 +02:00
```
### Description
You can use some parameters to fill meta tags and bases images:
```toml
[params]
description = "" # Description for the meta tag
favicon = "" # Favicon URL
logo = "" # Logo URL
2020-04-28 21:50:23 +02:00
keyword = "" # Keywords for the meta tag
2020-04-28 12:26:34 +02:00
```
The favicon is only the filename,
the file should be in *static/images* directory.
If favicon isn't set, the default test values are favicon.svg and favicon.png.
If none exists, there will be no favicon.
2020-04-28 21:50:23 +02:00
### Home page
2020-04-28 12:26:34 +02:00
2020-04-28 21:50:23 +02:00
The home page use one avatar, the name, one description and a list of social
networks.
For the social networks, see *Social Networks* chapter.
2020-04-28 12:26:34 +02:00
```toml
2020-04-28 21:50:23 +02:00
[params]
author = "Author" # The author of the website
info = "Your infos" # Displayed under author name
avatar = "file.png" # Placed in static/images
2020-04-28 12:26:34 +02:00
```
2020-04-28 21:50:23 +02:00
### 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:
2020-04-28 12:26:34 +02:00
```toml
[params]
2020-04-28 21:50:23 +02:00
twitterUser = "youruser" # Your Twitter account without @
2020-04-28 12:26:34 +02:00
```
2020-04-28 21:50:23 +02:00
### Custom CSS
2020-04-28 12:26:34 +02:00
```toml
2020-04-28 21:50:23 +02:00
[params]
custom_css = ["style.css"] # Your own css files
2020-04-28 12:26:34 +02:00
```
### Social Networks
2020-04-28 21:50:23 +02:00
You can also set some of your networks accounts to display on the home page.
Every social network (or not so network) have to be described with thoses
options:
2020-04-28 12:26:34 +02:00
```toml
2020-04-28 21:50:23 +02:00
[[params.social]]
name = "Title of the entry" # Title, used on hover
icon = "facebook" # Icon to use
weight = 1 # Sort order
url = "https://www.facebook.com/user" # Link to your account
2020-04-28 12:26:34 +02:00
```
2020-04-28 21:50:23 +02:00
You can also add some non social elements, you only need to have an icon.