Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/danielkvist/hugo-terrassa-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanielkvist <danielkvist@protonmail.com>2019-06-04 15:11:12 +0300
committerdanielkvist <danielkvist@protonmail.com>2019-06-04 15:11:12 +0300
commit787b3c5ce9c332c8d40d91aee09c75f5a101c38b (patch)
tree137f898d4bff06700fc0708046d2ea91cf1cdfa0
parentdfebf8b89f9dac854dea8a65e31b51dc43060989 (diff)
update README
-rw-r--r--README.md168
-rw-r--r--exampleSite/config.toml14
2 files changed, 163 insertions, 19 deletions
diff --git a/README.md b/README.md
index 8b73373..f7aa266 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,163 @@ theme = "terrassa"
## Configuration
-You can find an example of the final configuration [here](https://github.com/danielkvist/hugo-terrassa-theme/blob/master/exampleSite/config.toml).
+> You can find an example of the final configuration [here](https://github.com/danielkvist/hugo-terrassa-theme/blob/master/exampleSite/config.toml).
+
+### Basic
+
+```toml
+baseurl = "/" # The base URL of your Hugo site
+title = "titlehere" # The title of your Hugo site
+author = "authorhere" # The author name
+googleAnalytics = "" # Your Google Analytics tracking ID
+enableRobotsTXT = true
+language = "en-US"
+paginate = 7 # The numbers of posts per page
+theme = "terrassa" # Your Hugo theme
+```
+
+There's a lot more information about the basic configuration of an Hugo site [here](https://gohugo.io/getting-started/configuration/).
+
+### Description, favicon and logo params
+
+```toml
+[params]
+ description = "" # Description for the meta description tag
+ favicon = "" # Relative URL for your favicon
+ logo = "" # Absolute URL for your logo
+```
+
+### Hero
+
+```toml
+[params.hero]
+ textColor = "" # Empty for default color
+```
+
+### Call To Action
+
+```toml
+[params.cta] # Call To Action
+ show = true
+ cta = "Contact" # Text message of the CTA
+ link = "contact" # Relative URL
+```
+
+### Separators between Home sections
+
+```toml
+[params.separator]
+ show = false
+```
+
+### Contact information
+
+```toml
+[params.contact]
+ email = ""
+ phone = ""
+ skype = ""
+ address = ""
+```
+
+### Social Networks
+
+```toml
+[params.social]
+ twitter = ""
+ facebook = ""
+ github = ""
+ gitlab = ""
+ codepen = ""
+ instagram = ""
+ pinterest = ""
+ youtube = ""
+ linkedin = ""
+ weibo = ""
+ mastodon = ""
+ tumblr = ""
+ flickr = ""
+ "500px" = ""
+```
+
+> Icons for social networks depend on Font Awesome.
+
+### Font Awesome
+
+```toml
+[params.fa]
+ version = "" # Font Awesome version
+ integrity = "" # Font Awesome integrity for the Font Awesome script
+```
+
+### Copyright message
+
+```toml
+[params.copy]
+ message = ""
+```
+
+### Agreements
+
+```toml
+[params.agreement]
+ message = "" # You can use HTML tags
+```
+
+### Posts
+
+```toml
+[params.posts]
+ showAuthor = true
+ showDate = true
+ showTags = true
+ dateFormat = "Monday, Jan, 2006"
+```
+
+### Form
+
+```toml
+[params.form]
+ netlify = true # Only if you are using Netlify
+ action = ""
+ method = ""
+ inputNameName = ""
+ inputNameLabel = ""
+ inputNamePlaceholder = ""
+ inputEmailName = ""
+ inputEmailLabel = ""
+ inputEmailPlaceholder = ""
+ inputMsgName = ""
+ inputMsgLabel = ""
+ inputMsgLength = 750
+ inputSubmitValue = ""
+```
+
+### Privacy
+
+```toml
+[privacy]
+ [privacy.googleAnalytics]
+ anonymizeIP = true
+ disable = false
+ respectDoNotTrack = true
+ useSessionStorage = false
+ [privacy.instagram]
+ disable = false
+ simple = false
+ [privacy.twitter]
+ disable = false
+ enableDNT = true
+ simple = false
+ [privacy.vimeo]
+ disable = false
+ simple = false
+ [privacy.youtube]
+ disable = false
+ privacyEnhanced = true
+```
+
+To learn more about privacy configuration check the [official documentation](https://gohugo.io/about/hugo-and-gdpr/).
### Custom CSS
@@ -171,12 +327,4 @@ For the contact page follow these instructions:
$ hugo new contact/_index.md -k page
```
-The *title* and *description* will be used as the main title and subtitle respectively with a contact form. The rest of the options are defined in the [config.toml](https://github.com/danielkvist/hugo-terrassa-theme/blob/master/exampleSite/config.toml).
-
-## Config
-
-For the configuration check the [config.toml](https://github.com/danielkvist/hugo-terrassa-theme/blob/master/exampleSite/config.toml) of the *exampleSite* and the [official documentation](https://gohugo.io/getting-started/configuration/) to see all the options.
-
-## Font Awesome
-
-Terrassa uses the [Font Awesome](https://fontawesome.com/) icons through a CDN. Something that for the moment affects the performance.
+The *title* and *description* will be used as the main title and subtitle respectively with a contact form. The rest of the options are defined in the [config.toml](https://github.com/danielkvist/hugo-terrassa-theme/blob/master/exampleSite/config.toml). \ No newline at end of file
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 8631aec..efde359 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -4,19 +4,15 @@ author = "Daniel Zaragoza (Danielkvist)"
googleAnalytics = ""
defaultContentLanguage = "en"
language = "en-US"
-paginate = 3 # Number of posts per page
+paginate = 3
theme = "hugo-terrassa-theme"
themesDir = "../.." # Not necessary on production sites
-[outputs]
- home = ["HTML", "RSS"]
- page = ["HTML", "RSS"]
-
[params]
description = "Terrassa is a simple, fast and responsive theme for Hugo with a strong focus on accessibility made from scratch."
- favicon = "favicon.ico" # Relative URL
- logo = "" # Absolute URL
+ favicon = "favicon.ico"
+ logo = ""
[params.hero]
textColor = "" # Empty for default color
@@ -34,7 +30,7 @@ themesDir = "../.." # Not necessary on production sites
integrity = "sha384-0pzryjIRos8mFBWMzSSZApWtPl/5++eIfzYmTgBBmXYdhvxPc+XcFEk+zJwDgWbP"
[params.form] # Contact form
- netlify = true # Use only if you are using Netlify
+ netlify = true
action = "https://formspree.io/your@email.com"
method = "POST"
inputNameName = "name"
@@ -60,7 +56,7 @@ themesDir = "../.." # Not necessary on production sites
skype = ""
address = "419 Creek St. Revere, MA 02151"
-[params.social] # Social networks
+[params.social]
twitter = "https://twitter.com/john"
facebook = "https://facebook.com/john"
github = "https://github.com/john"