diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b3bf94..3bfd5c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,5 @@ 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). ## [Unreleased] - -## [v1.0.0] - 2020-04-28 ### Added -* Make theme standalone. +* Making theme standalone. diff --git a/README.md b/README.md index 79a0f2f..d27c299 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,7 @@ 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" -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 +theme = "idunn" # The Hugo theme ``` ### Description @@ -47,31 +36,18 @@ You can use some parameters to fill meta tags and bases images: description = "" # Description for the meta tag favicon = "" # Favicon URL logo = "" # Logo URL - keyword = "" # Keywords for the meta tag ``` -### Home page +### 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. +It is possible to basicaly change some colors: ```toml -[params] - author = "Author" # The author of the website - info = "Your infos" # Displayed under author name - avatar = "file.png" # Placed in static/images -``` - -### 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 @ +[params.colors] + font = "black" # General font color, default to black + background = "white" # General background color, default to white + main = "grey" # Theme color, used for footer among others, default to grey + font_above = "white" # Used for font above *main* color, default to white ``` ### Custom CSS @@ -81,18 +57,38 @@ add the following option to your config file: custom_css = ["style.css"] # Your own css files ``` -### Social Networks +### Contact footer -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: +If you want to have some informations about you in the footer, +you can set it with thoses parameters: ```toml -[[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 +[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 ``` -You can also add some non social elements, you only need to have an icon. +### Social Networks + +You can also set some of your networks accounts. +Thoses options are availables: + +```toml +[params.social] + 500px = "" + codepen = "" + facebook = "" + flickr = "" + github = "" + gitlab = "" + instagram = "" + linkedin = "" + mastodon = "" + peertube = "" + pinterest = "" + pixelfed = "" + tumblr = "" + twitter = "" + youtube = "" +``` diff --git a/layouts/partials/author.html b/layouts/partials/author.html index 2c70632..70c485e 100644 --- a/layouts/partials/author.html +++ b/layouts/partials/author.html @@ -6,5 +6,19 @@