Release commit for version 3.0

7 files changed, 462 insertions, 52 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7f4ae15..5b59619 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -31,3 +31,6 @@ GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-o
 
 7. Let the title of your pull request clearly indicate what kind of change it
    is.
+
+If the pull request does not meet the specifications, it is pointed out once,
+if there is no improvement the PR is simply closed.
diff --git a/FEATURES.md b/FEATURES.md
new file mode 100644
index 0000000..0eeb846
--- /dev/null
+++ b/FEATURES.md
@@ -0,0 +1,120 @@
+# Features
+
+## GDPR in mind
+
+The GDPR has many rules for third party assets, so if you don't want to think
+about GDPR complaints you can disable every third party asset that is
+integrated.
+
+Some websites using webfonts from third party sites like google. This theme
+brings FontAwesome and Roboto(-Slab) directly with it, without having to
+integrate them via third party sites.
+
+## Multilingual support for month names and fixed strings
+
+### month names
+
+Due to the currently unavailable feature for multilingual dates in `.Date`
+from Go. It is possible to create a `month.yaml` in the data folder of your
+Hugo site root directory. There is also an example file in
+`exampleSite/data/`.
+
+```sh
+cat > month.yaml << EOF
+1: "Jan"
+2: "Feb"
+3: "Mar"
+4: "Apr"
+5: "May"
+6: "Jun"
+7: "Jul"
+8: "Aug"
+9: "Sep"
+10: "Oct"
+11: "Nov"
+12: "Dec"
+EOF
+```
+
+### fixed strings
+
+There are some fixed strings in the html files that normally uses only the set
+language. But if you create a folder `i18n/` in the root directory of your
+hugo site and copy the `en.yaml` that comes with the theme you can edit the
+fixed strings to your liking. Don't forget to also set
+`defaultContentLanguage = "en"` to the new language.
+
+```sh
+mkdir i18n
+cd i18n
+cp ../themes/hugo-vitae/i18n/en.yaml en.yaml
+# Edit the new language file
+```
+
+## FontAwesome for social icons
+
+FontAwesome is mainly used for the icons of the social navbar in the top right
+corner of the theme. In the config of your Hugo website there is a param
+called `icon` for the `params.social` section. I could look like this:
+
+```toml
+[[params.social]]
+name = "Github"
+icon = "fab fa-github"
+url = "https://github.com/dataCobra/hugo-vitae"
+```
+
+On the [FontAwesome](https://fontawesome.com) website, you can look up every
+free icon and also the information you need to put into this `icon` param.
+
+## Site configuration options (config.toml)
+
+ - **.Site.Params.homepage** # Enable/Disable homepage use instead of a list
+ - **.Site.Params.keywords** # Add meta keywords in head part (Site Keywords or Tags of Page)
+ - **.Site.Params.description** # Add meta description in head part (Site Description or Description of Page)
+ - **.Site.Params.math** # Add math typesetting with KaTeX (Global with this param)
+ - **.Site.Params.customcss** # Add path to customcss you want to add to the theme
+ - **.Site.Params.customjs.enabled** # Enable/Disable customjs
+ - **.Site.Params.customjs.src** # add the source path
+ - **.Site.Params.customjs.referrerpolicy # specifies which referrer information to send when fetching the script
+ - **.Site.Params.customjs.nomodule** # specifies that the script should not be executed in browsers supporting ES2015 modules
+ - **.Site.Params.customjs.integrity** # allows a browser to check for integrity to ensure the code hasn't been manipulated
+ - **.Site.Params.customjs.defer** # execute the script when page has finished parsing (external only)
+ - **.Site.Params.customjs.crossorigin** # sets the mode of the request to an http cors request
+ - **.Site.Params.customjs.async** # executes the script asynchronously (external only)
+ - **.Site.Params.pagetitle** # Add pagetitle to homepage <title> tag
+ - **.Site.Params.avatar** # Add a avatar to your website
+ - **.Site.Params.subtitle** # Add a subtitle to your website
+ - **.Site.Params.social** # Add different social links to your website
+ - **.Site.Params.readingTime** # Show reading time for a post
+ - **.Site.Params.wordCount** # Show word count for a post
+ - **.Site.Params.hideAuthor** # Show author for a post
+ - **.Site.Params.excludedTypes** # Exclude specific types in lists
+ - **.Site.Params.mainSections** # Add list of sections that should show up on the homepage
+ - **.Site.Params.nofeedSections** # Add list of sections/types that should not be considered by RSS
+ - **.Site.Params.disableTaxoTypes** # Deactivate taxonomies for specific page types
+ - **.Site.Params.favicon** # Activate favicons for the website
+ - **.Site.Params.comments.enabled** # Enable/Disable comments for website entirely
+ - **.Site.Params.comments.engine** # Either disqus or commento to choose from
+ - **.Site.Params.comments.disableOnTypes** # Deactivate comments for specific page types
+ - **.Site.Params.comments.disqus.shortname** # New param for the shortname of a disqus instance
+ - **.Site.Params.comments.commento.host** # Domain http/s of commento.io system of choice
+
+## Front matter options for content
+
+ - **.Params.tags** # https://gohugo.io/variables/page/#page-level-params**
+ - **.Params.nofeed** # Don't add page to RSS file
+ - **.Params.math** # Add math typesetting with KaTeX to a specific page
+ - **.Params.author** # Add the author of a page
+ - **.Params.authorlink** # Add the create a link to a page of the author
+ - **.Params.notaxonomy** # Don't show this list of taxnomoies below the content
+ - **.Params.type** # https://gohugo.io/content-management/types/**
+ - **.Params.commentable** # Enable/Disable comments for this specific page
+ - **.Params.hidden** # Hide page from the mainSections on the homepage
+ - **.Params.norobots** # Disallow page in robots.txt for search engines
+ - **.Params.nodate** # Hide the publish date of specific content
+ - **.Params.image** # Add an image to the post
+ - **.Params.imagetext** # Add alternate text for the image to the post
+ - **.Params.hidemeta** # Hide the metadata (readingTime, wordCount and Author)
+
+Examples for site configuration and front matter can be found in `examples/`.
diff --git a/README.md b/README.md
index c1c9913..42f71f5 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,34 @@
 # Vitae
 ... is a feature-rich blog theme for Hugo that **focuses on your content**.
 
-## Version 3.0 in development
+## :mega: Version 3.0 is finally released!
 
-I am currently working out how to proceed with the theme and what
-improvements and changes to consider for the upcoming release.
+I've finally finished the development of version 3.0 and this is the last and
+final version of Vitae. From now on only bugs will be fixed and if necessary
+the program code will be refactored.
 
-Licensed under the [GPL-3.0-or-later](https://raw.githubusercontent.com/dataCobra/hugo-vitae/master/COPYING).
+## Screenshot
+
+![Screenshot](https://raw.githubusercontent.com/dataCobra/hugo-vitae/main/images/screenshot.png)
+
+**!Since version 3.0, the default branch is MAIN and no longer MASTER!**
+
+## Installation
+
+Download the [latest stable release](https://github.com/dataCobra/hugo-vitae/releases/latest).
+It's available as `.zip` or `.tar.gz`. Decompress it into your `themes/` folder.
+
+For more information about installation read the
+[official setup guide](https://gohugo.io/overview/installing/) of Hugo.
+
+## Features
+
+All configuration options can be looked up in the [FEATURES.md](https://github.com/dataCobra/hugo-vitae/blob/main/FEATURES.md).
+
+## Credits
+
+* [freepik](https://www.freepik.com) for the avatar
+* [google](https://fonts.google.com/specimen/Roboto) for the roboto fonts
+* [fontawesome](https://fontawesome.com) for providing amazing icons
+
+Licensed under the [GPL-3.0-or-later](https://raw.githubusercontent.com/dataCobra/hugo-vitae/main/COPYING).
diff --git a/examples/config.toml b/examples/config.toml
new file mode 100644
index 0000000..301147d
--- /dev/null
+++ b/examples/config.toml
@@ -0,0 +1,154 @@
+seURL = "http://example.org/"
+languageCode = "en-us"
+defaultContentLanguage = "en"
+author = "Hugo Authors"
+title = "Vitae"
+theme = "hugo-vitae"
+paginate = 5
+enableRobotsTXT = true
+
+copyright = "© Copyright notice | [Vitae](https://github.com/dataCobra/hugo-vitae) theme for [Hugo](https://gohugo.io)"
+
+pygmentsstyle = "colorful"
+pygmentscodefences = true
+pygmentscodefencesguesssyntax = true
+
+googleAnalytics = ""
+
+[taxonomies]
+	tag = "tags"
+	category = "categories"
+	series = "series"
+
+[params]
+	# Use homepage.md instead of a list of posts
+	homepage = false
+
+	# Add meta keywords in head part (Site Keywords or Tags of Page)
+	keywords = ["hugo","vitae","theme","static"]
+
+	# Add meta description in head part
+	description = "Vitae is a blog theme for Hugo that focuses on your content."
+
+	# Add pagetitle to homepage <title> tag
+	pagetitle = "All about static site generation"
+
+	# Add a subtitle to your website
+	subtitle = "[Vitae](https://github.com/dataCobra/hugo-vitae) is a blog theme for Hugo that focuses on your content."
+
+	# Add math typesetting with KaTeX (Global with this Param)
+	math = true
+
+	# Optional 80x80 avatar image.
+	avatar = "/img/vitae.jpg"
+
+	# Optional favicons for website
+	#favicon = true
+
+	# Add list of sections that should show up on the homepage
+	mainSections = ["post"]
+
+	# Add list of Sections/Types that should no be considered by RSS
+	#nofeedSections = ["post"]
+
+	# Deactivate Taxonomies for specific page types
+	#disableTaxoTypes = [""]
+
+	# Custom CSS applied to default styles. (Path could be "static/css/")
+	#customcss = "css/custom.css"
+
+	# Show reading time on a post
+	readingTime = false
+
+	# Show word count on a post
+	wordCount = false
+
+	# Show author on a post (groups with readingTime and wordCount)
+	hideAuthor = true
+
+# Custom JavaScript
+[params.customjs]
+# enable Javascript by setting to true
+enabled = false
+
+# add a filepath (could be "static/js/")
+#src = "js/main.js"
+
+# specifies which referrer information to send when fetching the script
+#referrerpolicy = "no-referrer"
+
+# specifies that the script should not be executed in browsers supporting ES2015 modules
+#nomodule = false
+
+# Allows a browser to check for integrity to ensure the code hasn't been manipulated
+#integrity= ""
+
+# execute the script when page has finished parsing (external only)
+#defer = true
+
+# sets the mode of the request to an http cors request
+#crossorigin=true
+
+# executes the script asynchronously (external only)
+#async = true
+
+# Comments
+[params.comments]
+# Enable Comments with "true"
+enabled = false
+
+# Comment provider:
+#   disqus (https://disqus.com)
+#   commento (https://commento.io)
+#engine = "disqus"
+
+# Content types to disable comments on.
+#disableOnTypes = ["page"]
+
+[params.comments.disqus]
+#shortname = "" # Paste the shortname from your Disqus dashboard.
+
+[params.comments.commento]
+#host = "" # Paste the domain of you commento.io system
+
+# Navigation
+[[menu.main]]
+name = "Home"
+url = "/"
+weight = 1
+
+[[menu.main]]
+name = "All Posts"
+url = "/post"
+weight = 2
+
+[[menu.main]]
+name = "About"
+url = "/about"
+weight = 3
+
+[[menu.main]]
+name = "Tags"
+url = "/tags"
+weight = 4
+
+[[menu.main]]
+name = "Categories"
+url = "/categories"
+weight = 5
+
+# Social Menu
+[[params.social]]
+name = "Github"
+icon = "fab fa-github"
+url = "https://github.com/dataCobra/hugo-vitae"
+
+#[[params.social]]
+#name = "Email"
+#icon = "fas fa-envelope"
+#cmd = "mailto:example@example.com"
+
+[[params.social]]
+name = "RSS"
+icon = "fas fa-rss"
+url = "/index.xml"
diff --git a/examples/example-content.md b/examples/example-content.md
new file mode 100644
index 0000000..ee28efc
--- /dev/null
+++ b/examples/example-content.md
@@ -0,0 +1,155 @@
++++
+author = "Hugo Authors"
+authorlink = "https://gohugo.io"
+title = "Markdown Syntax Guide"
+date = "2019-03-11"
+description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
+tags = [
+    "markdown",
+    "css",
+    "html",
+    "themes",
+]
+categories = [
+    "themes",
+    "syntax",
+]
+nofeed = true
+math = true
+notaxonomy = false
+commentable = true
+hidden = false
+norobots = true
+nodate = false
+images = ["/img/example.jpg"]
+imagetext = "An example text for an image you could add!"
+hidemeta = false
++++
+
+This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
+<!--more-->
+
+## Headings
+
+The following HTML `<h1>`—`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.
+
+# H1
+## H2
+### H3
+#### H4
+##### H5
+###### H6
+
+## Paragraph
+
+Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
+
+Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
+
+## Blockquotes
+
+The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations.
+
+#### Blockquote without attribution
+
+> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
+> **Note** that you can use *Markdown syntax* within a blockquote.
+
+#### Blockquote with attribution
+
+> Don't communicate by sharing memory, share memory by communicating.</p>
+> — <cite>Rob Pike[^1]</cite>
+
+
+[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
+
+## Tables
+
+Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box.
+
+   Name | Age
+--------|------
+    Bob | 27
+  Alice | 23
+
+#### Inline Markdown within tables
+
+| Inline&nbsp;&nbsp;&nbsp;     | Markdown&nbsp;&nbsp;&nbsp;  | In&nbsp;&nbsp;&nbsp;                | Table      |
+| ---------- | --------- | ----------------- | ---------- |
+| *italics*  | **bold**  | ~~strikethrough~~&nbsp;&nbsp;&nbsp; | `code`     |
+
+## Code Blocks
+
+#### Code block with backticks
+
+```
+html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Example HTML5 Document</title>
+</head>
+<body>
+  <p>Test</p>
+</body>
+</html>
+```
+#### Code block indented with four spaces
+
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+      <meta charset="UTF-8">
+      <title>Example HTML5 Document</title>
+    </head>
+    <body>
+      <p>Test</p>
+    </body>
+    </html>
+
+#### Code block with Hugo's internal highlight shortcode
+{{< highlight html >}}
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Example HTML5 Document</title>
+</head>
+<body>
+  <p>Test</p>
+</body>
+</html>
+{{< /highlight >}}
+
+## List Types
+
+#### Ordered List
+
+1. First item
+2. Second item
+3. Third item
+
+#### Unordered List
+
+* List item
+* Another item
+* And another item
+
+#### Nested list
+
+* Item
+1. First Sub-item
+2. Second Sub-item
+
+## Other Elements — abbr, sub, sup, kbd, mark
+
+<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
+
+H<sub>2</sub>O
+
+X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
+
+Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
+
+Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.
diff --git a/features.md b/features.md
deleted file mode 100644
index e4077ab..0000000
--- a/features.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Features
-
- - .Site.Params.homepage  # Enable/Disable homepage use instead of a list
- - .Site.Params.keywords  # Add meta keywords in head part (Site Keywords or Tags of Page)
- - .Site.Params.description # Add meta description in head part (Site Description or Description of Page)
- - .Site.Params.math # Add math typesetting with KaTeX (Global with this param)
- - .Site.Params.customcss # Add path to customcss you want to add to the theme
- - .Site.Params.customjs.enabled # Enable/Disable customjs
- - .Site.Params.customjs.src # add the source path
- - .Site.Params.customjs.referrerpolicy # specifies which referrer information to send when fetching the script
- - .Site.Params.customjs.nomodule # specifies that the script should not be executed in browsers supporting ES2015 modules
- - .Site.Params.customjs.integrity # allows a browser to check for integrity to ensure the code hasn't been manipulated
- - .Site.Params.customjs.defer # execute the script when page has finished parsing (external only)
- - .Site.Params.customjs.crossorigin # sets the mode of the request to an http cors request
- - .Site.Params.customjs.async # executes the script asynchronously (external only)
- - .Site.Params.pagetitle # Add pagetitle to homepage <title> tag
- - .Site.Params.avatar # Add a avatar to your website
- - .Site.Params.subtitle # Add a subtitle to your website
- - .Site.Params.social # Add different social links to your website
- - .Site.Params.readingTime # Show reading time for a post
- - .Site.Params.wordCount # Show word count for a post
- - .Site.Params.hideAuthor # Show author for a post
- - .Site.Params.excludedTypes # Exclude specific types in lists
- - .Site.Params.mainSections # Add list of sections that should show up on the homepage
- - .Site.Params.nofeedSections # Add list of sections/types that should not be considered by RSS
- - .Site.Params.disableTaxoTypes # Deactivate taxonomies for specific page types
- - .Site.Params.favicon # Activate favicons for the website
- - .Site.Params.comments.enabled # Enable/Disable comments for website entirely
- - .Site.Params.comments.engine # Either disqus or commento to choose from
- - .Site.Params.comments.disableOnTypes # Deactivate comments for specific page types
- - .Site.Params.comments.disqus.shortname # New param for the shortname of a disqus instance
- - .Site.Params.comments.commento.host # Domain http/s of commento.io system of choice
-
- - .Params.tags # https://gohugo.io/variables/page/#page-level-params
- - .Params.nofeed # Don't add page to RSS file
- - .Params.math # Add math typesetting with KaTeX to a specific page
- - .Params.author # Add the author of a page
- - .Params.authorlink # Add the create a link to a page of the author
- - .Params.notaxonomy # Don't show this list of taxnomoies below the content
- - .Params.type # https://gohugo.io/content-management/types/
- - .Params.commentable # Enable/Disable comments for this specific page
- - .Params.hidden # Hide page from the mainSections on the homepage
- - .Params.norobots # Disallow page in robots.txt for search engines
- - .Params.nodate # Hide the publish date of specific content
- - .Params.image # Add an image to the post
- - .Params.imagetext # Add alternate text for the image to the post
- - .Params.hidemeta # Hide the metadata (readingTime, wordCount and Author)
diff --git a/theme.toml b/theme.toml
index 5d57466..be5f9c8 100644
--- a/theme.toml
+++ b/theme.toml
@@ -3,7 +3,7 @@
 
 name = "Vitae"
 license = "GPL-3.0-or-later"
-licenselink = "https://github.com/dataCobra/hugo-vitae/blob/master/COPYING"
+licenselink = "https://github.com/dataCobra/hugo-vitae/blob/main/COPYING"
 description = "Vitae is a feature-rich blog theme for Hugo that focuses on your content."
 homepage = "https://github.com/dataCobra/hugo-vitae"
 tags = ["blog", "responsive", "clean", "simple", "light", "disqus", "commento", "mobile", "customizable", "minimalistic", "typography", "fontawesome", "reading"]