Updated links, docs, exampleSite

5 files changed, 124 insertions, 31 deletions

diff --git a/README.md b/README.md
index c4081c6..b73ab20 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Vibrant Shadows
 
-An insanely customizable, extremely lightweight and ridiculously fast 'Blog Theme' for Hugo, with mobile support and a lot more..<!--, with mobile support, built-in PWA support, contact page and a lot more.-->
+An insanely customizable, extremely lightweight and ridiculously fast 'Blog Theme' for Hugo, with mobile support and a lot more.<!--built-in PWA support, contact page and a lot more.-->
 
 ## Preview
 
@@ -30,7 +30,7 @@ An insanely customizable, extremely lightweight and ridiculously fast 'Blog Them
 
 * Blog with custom Taxonomy options, including tagging and category options
 * Deeplinks
-* Insanely customizable (see config)
+* Insanely customizable (see [config](#configuration))
 * Dedicated 'Table of Contents'
 * Logo alignment
 * Sane defaults
@@ -60,11 +60,13 @@ cd yourSiteName # move in to the Hugo website's directory
 
 #### 1. As a Hugo Module (recommended)
 
-Simply add the repo to your theme option in `config.yaml`:
+1. Download the repo on your machine
+2. Extract the zip file and rename the folder from `HugoTheme-VibrantShadows-master` to `HugoTheme-VibrantShadows`.
+3. Copy this folder and paste it into you Hugo Website directory.
+4. Simply add the repo to your theme option in `config.yaml`:
 
 ```yaml
-theme:
-  - github.com/Softorage/HugoTheme-VibrantShadows
+theme: "HugoTheme-VibrantShadows"
 ```
 
 #### 2. As Git Submodule
@@ -73,8 +75,8 @@ Inside the folder of your Hugo site run:
 
 ```bash
 git init # to initiate git if it isn't already
-git submodule add https://github.com/Softorage/HugoTheme-VibrantShadows.git themes/vibrant-shadows # add theme as a git submodule
-cp -a themes/vibrant-shadows/exampleSite/* . # 
+git submodule add https://github.com/Softorage/HugoTheme-VibrantShadows.git themes/HugoTheme-VibrantShadows # add theme as a git submodule
+cp -a themes/HugoTheme-VibrantShadows/exampleSite/* . # start with the boilerplate by copying it into current directory
 ```
 
 Then run
@@ -155,7 +157,7 @@ These options set global values that some pages or all pages in the site use by
     
     Example:
     ```yaml
-    theme: "vibrant-shadows"
+    theme: "HugoTheme-VibrantShadows"
     ```
 7.  **Google Analytics** *(Type: String | Accepts value: Alphanumeric | Optional | No default)*
     
@@ -339,7 +341,7 @@ Let's see them one by one.
         ```yaml
         contentLicense: "All rights reserved." # Another example: 'CC-BY-SA-3.0'
       ```
-    6. **Title Separator** *(Type: String | Accepts value: Text | Optional | Default: " | ")*
+    6.  **Title Separator** *(Type: String | Accepts value: Text | Optional | Default: " | ")*
         
         It is used in website/blog title, to separate (say) page title from website/blog title.
         
@@ -347,7 +349,7 @@ Let's see them one by one.
         ```yaml
         titleSeparator: " | "
         ```
-    7. **Attribution** *(Type: String | Accepts value: enable/disable | Optional | Default: "enable")*
+    7.  **Attribution** *(Type: String | Accepts value: enable/disable | Optional | Default: "enable")*
         
         Allows to attribute Hugo team for awesome software and Softorage for great theme.
         
@@ -753,7 +755,7 @@ Let's see them one by one.
 
 ## Contributing
 
-If you have a tip, feedback or issues, please [open an issue here].If you think 'Vibrant Shadows' theme could benefit from some features, or there is something that needs to be fixed, please open an issue at least 2-3 days prior to [opening a PR]. If you think there is something that needs to be fixed and which isn't of much significance (say a typo), you may open a PR directly.
+If you have a tip, feedback or issues, please [open an issue here](https://github.com/Softorage/HugoTheme-VibrantShadows/issues).If you think 'Vibrant Shadows' theme could benefit from some features, or there is something that needs to be fixed, please open an issue at least 2-3 days prior to [opening a PR](https://github.com/Softorage/HugoTheme-VibrantShadows/pulls). If you think there is something that needs to be fixed and which isn't of much significance (say a typo), you may open a PR directly.
 
 Anyone contributing, benefits equally from others' contributions.
 
@@ -782,4 +784,4 @@ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-License can be viewed [here].
+License can be viewed [here](https://github.com/Softorage/HugoTheme-VibrantShadows/blob/master/LICENSE).
diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml
index becf747..f139739 100644
--- a/exampleSite/config.yaml
+++ b/exampleSite/config.yaml
@@ -4,7 +4,7 @@ baseURL: "https://example.com/" # url address of the website | required
 title: "Vibrant Shadows Theme" # title of the site; usually same as brand name | required
 copyright: "Copyright &#169; 2020 Softorage. All rights reserved." # should match 'brand -> name', and 'contentLicense' under params below; used in default rss template: https://gohugo.io/templates/rss/#configure-rss | optional
 languageCode: "en-us" # recommended | no default
-theme: "vibrant-shadows"
+theme: "HugoTheme-VibrantShadows"
 # googleAnalytics: "UA-123456789-0" # Respecting your preference from 'privacy', and 'params' -> 'user_experience' below, if you set this value, Google Analytics code will be included. Google Analytics included only when serving the website on 'production' environment (i.e. website built with `hugo` command and not `hugo serve`)
 # disqusShortname: "yourdiscussshortname" # Respecting your preference from 'privacy', if you set this value, Disqus comments code will be included at the end of the blog posts. Disqus comments are shown only when serving the website on 'production' environment (i.e. website built with `hugo` command and not `hugo serve`)
 
diff --git a/exampleSite/content/post/Additional info.md b/exampleSite/content/post/Additional info.md
index 0e7b825..2c20e80 100644
--- a/exampleSite/content/post/Additional info.md
+++ b/exampleSite/content/post/Additional info.md
@@ -2,6 +2,7 @@
 title: "Additional information about the theme"
 author: "Sanmay Joshi"
 description: "Additional info about the theme, like 'Built with', 'Contributing', and 'License'."
+tags: ["learn more", "license"]
 date: "2020-09-30"
 ---
 We share some additional information about this theme, that may be relevant.
@@ -16,7 +17,7 @@ We share some additional information about this theme, that may be relevant.
 
 ## Contributing
 
-If you have a tip, feedback or issues, please [open an issue here].If you think 'Vibrant Shadows' theme could benefit from some features, or there is something that needs to be fixed, please open an issue at least 2-3 days prior to [opening a PR]. If you think there is something that needs to be fixed and which isn't of much significance (say a typo), you may open a PR directly.
+If you have a tip, feedback or issues, please [open an issue here](https://github.com/Softorage/HugoTheme-VibrantShadows/issues).If you think 'Vibrant Shadows' theme could benefit from some features, or there is something that needs to be fixed, please open an issue at least 2-3 days prior to [opening a PR](https://github.com/Softorage/HugoTheme-VibrantShadows/pulls). If you think there is something that needs to be fixed and which isn't of much significance (say a typo), you may open a PR directly.
 
 Anyone contributing, benefits equally from others' contributions.
 
@@ -45,4 +46,4 @@ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ```
 
-License can be viewed [here].
+License can be viewed [here](https://github.com/Softorage/HugoTheme-VibrantShadows/blob/master/LICENSE).
diff --git a/exampleSite/content/post/Configuration.md b/exampleSite/content/post/Configuration.md
index b8fa2e5..1b410d9 100644
--- a/exampleSite/content/post/Configuration.md
+++ b/exampleSite/content/post/Configuration.md
@@ -2,6 +2,7 @@
 title: "Configuration options in the theme"
 author: "Sanmay Joshi"
 description: "Get to know all the awesome configurations Vibrant Shadows Hugo theme has to offer."
+tags: ["configuration", "customize", "settings"]
 date: "2020-09-30"
 ---
 Here, we will mainly see settings that are unique to this theme. If something is not covered here (or elsewhere in this file), there's a good chance it is covered in [this Hugo docs page](https://gohugo.io/getting-started/configuration/#configuration-file).
@@ -63,7 +64,7 @@ These options set global values that some pages or all pages in the site use by
     
     Example:
     ```yaml
-    theme: "vibrant-shadows"
+    theme: "HugoTheme-VibrantShadows"
     ```
 7.  **Google Analytics** *(Type: String | Accepts value: Alphanumeric | Optional | No default)*
     
@@ -110,7 +111,16 @@ These options set global values that some pages or all pages in the site use by
           parent: "about"
           weight: 1
     ```
-11. **Privacy** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
+11. **Build Stats** *(Type: Map/Dict/Object | Accepts value: - | Required)*
+    
+    With this, Hugo notes some stats about website, which are then used by CSS processors.
+    
+    Example:
+    ```yaml
+    build:
+      writeStats: true
+    ```
+12. **Privacy** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
     
     This feature allows to maintain optimal privacy settings for the website/blog. You can see full list of privacy settings [here](https://gohugo.io/about/hugo-and-gdpr/#all-privacy-settings), and their explanation [here](https://gohugo.io/about/hugo-and-gdpr/#the-privacy-settings-explained).
     
@@ -118,12 +128,12 @@ These options set global values that some pages or all pages in the site use by
     ```yaml
     privacy:
       disqus:
-        disable: "false"
+        disable: "false" # | default: false
       googleAnalytics:
-        anonymizeIP: "false" # 'true' makes it so the users' IP addresses are anonymized within Google Analytics
-        disable: "false"
-        respectDoNotTrack: "false" # 'true' makes the GA templates respect the “Do Not Track” HTTP header
-        useSessionStorage: "false" # 'true' disables the use of Cookies and use Session Storage to Store the GA Client ID
+        anonymizeIP: "true" # 'true' makes it so the users' IP addresses are anonymized within Google Analytics | default: false
+        disable: "false" # | default: false
+        respectDoNotTrack: "false" # 'true' makes the GA templates respect the “Do Not Track” HTTP header | default: false
+        useSessionStorage: "false" # 'true' disables the use of Cookies and use Session Storage to Store the GA Client ID | default: false
     ```
 
 ### Vibrant Shadow's custom parameters
@@ -246,6 +256,14 @@ Let's see them one by one.
         ```yaml
         titleSeparator: " | "
         ```
+    7. **Attribution** *(Type: String | Accepts value: enable/disable | Optional | Default: "enable")*
+        
+        Allows to attribute Hugo team for awesome software and Softorage for great theme.
+        
+        Example:
+        ```yaml
+        attribution: "enable"
+        ```
 3.  **Brand** *(Type: Map/Dict/Object | Accepts value: - | Highly Recommended)*
     
     It stores brand related information. It contains:
@@ -443,7 +461,76 @@ Let's see them one by one.
         appID: "170405085280305" # it is just for illustration purpose
       jsonLD: "enable"
     ```
-10. **User Experience** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
+10. **Cookie Consent** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
+    
+    It allows you to present a 'Cookie Consent' dialog to your users, to help them decide their privacy settings, when they browse your website. It contains:
+    1.  **Switch** *(Type: String | Accepts value: on/off | Optional | Default: "off")*
+      
+        It lets you choose whether you want to show a Cookie Consent dialog to your users.
+    2.  **Type** *(Type: String | Accepts value: opt-in/opt-out/none | Required | No default)*
+        
+        In 'opt-in', website doesn't employ cookies to user's computer unless user gives cosent to opt in. In 'opt-out', cookies are employed on user's computer and the user is given the choice to opt out of cookies. In 'none', cookies are employed on the user's computer and user is not given a choice in that regard. We recommend to refrain from using none, unless you have **zero** customers from EU or similar countries with privacy protecting laws.
+    3.  **Revokable** *(Type: Boolean | Accepts value: true/false | Optional | Default: true)*
+        
+        When set to `true`, a button to revoke cookie consent appears when the user hover in bottom area of the screen, regardless whether user's country requires revertable cookie consent.
+    4.  **Colors** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
+        
+        It lets you customize the colors for Cookie Consent dialog. It contains:
+        1.  **Banner** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
+            
+            It lets you customize colors of banner for Cookie Consent. It contains: **background** and **text**.
+        2.  **Button** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
+            
+            It lets you customize colors of button for Cookie Consent. It contains: **background** and **text**.
+    5.  **Content** *(Type: Map/Dict/Object | Accepts value: - | Required)*
+        
+        It lets you customize the content you wish to show on Cookie Consent dialog. It contains:
+        1.  **Message** *(Type: String | Accepts value: Text | Required | No default)*
+            
+            It lets you customize the message to be shown in Cookie Consent. You can even use `<a>`-anchor tags to hyperlink words.
+        2.  **Dismiss** *(Type: String | Accepts value: Text | Optional | Default: "Close")*
+
+            It's the text on the button that dismisses the popup/banner.
+        3.  **Link Text** *(Type: String | Accepts value: Text | Optional | Default: "Learn more")*
+            
+            This text appears after the `message` and is hyperlinked to `linkURL`.
+        4.  **Link URL** *(Type: String | Accepts value: Text | Required | No default)*
+            
+            It's the url of location where user should be directed when they click "Learn more".
+        5.  **Allow** *(Type: String | Accepts value: Text | Optional |Default: "Allow")*
+            
+            It is the text on the button that allows cookies.
+        6.  **Deny** *(Type: String | Accepts value: Text | Optional | Default: "Decline")*
+            
+            It is the text on the button that denies cookies.
+        7.  **Policy** *(Type: String | Accepts value: Text | Optional | Default: "Cookie Consent")*
+            
+            It is the text that appears on the button, when user's country requires revokable cookie consent.
+            
+    Example:
+    ```yaml
+    cookieConsent: # we use OSANO Cookie Consent solution
+      switch: "on"
+      type: "opt-in"
+      revokable: true
+      colors:
+        banner:
+          background: "#ffffff"
+          text: "#000000"
+        button:
+          background: "#6d19fc"
+          text: "#ffffff"
+      content: # change the links below to appropriate url addresses
+        message: |
+          By continuing to use this website, you agree to our <a href='/legal/privacy-policy/'>Privacy Policy</a>, <a href='/legal/cookie-policy/'>Cookie Policy</a> and our <a href='/legal/terms-and-conditions/'>Terms and Conditions</a> for your use of this website.
+        dismiss: "Close"
+        linkText: "Learn more"
+        linkURL: "/legal/privacy-policy/"
+        allow: "Allow"
+        deny: "Decline"
+        policy: "Cookie Consent"
+    ```
+11. **User Experience** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
     
     It contains settings that let's you customize your user's website/blog experience.
     1.  **Google Analytics Loading** *(Type: String | Accepts value: sync/async | Optional | Default: "sync")*
@@ -455,7 +542,7 @@ Let's see them one by one.
     userExperience:
       googleAnalyticsLoading: "sync"
     ```
-11. **Main Sections** *(Type: Array | Accepts value: Section names | Highly Recommended)*
+12. **Main Sections** *(Type: Array | Accepts value: Section names | Highly Recommended)*
     
     This is Hugo's native feature that let's you specify which sections are to be treated as *Main Sections*. A very general and common example of *Main Section* is `post` or `posts` section (hence they are often called Blog Directories). If nothing is specified, the section with the highest number of content files is treated as a *Main Section*. For more info, see the [Hugo docs](https://gohugo.io/functions/where/#mainsections).
     
diff --git a/exampleSite/content/post/Getting Started.md b/exampleSite/content/post/Getting Started.md
index f551544..55eef3e 100644
--- a/exampleSite/content/post/Getting Started.md
+++ b/exampleSite/content/post/Getting Started.md
@@ -2,6 +2,7 @@
 title: "Getting started with Vibrant Shadows"
 author: "Sanmay Joshi"
 description: "Read the full post to easily get started with Vibrant Shadows Hugo theme."
+tags: ["get started", "guide"]
 date: "2020-09-30"
 ---
 It's very easy to get started with Vibrant Shadows. How? Read on.
@@ -10,13 +11,13 @@ It's very easy to get started with Vibrant Shadows. How? Read on.
 
 ## Prerequisites
 
-Firstly, *ensure you have installed the [extended version of Hugo](https://github.com/gohugoio/hugo/releases)*. You may need to scroll down a bit to see extended versions. Alternatively, you may see installation steps from [Hugo's official docs](https://gohugo.io/getting-started/installing/).
+Firstly, *ensure you have installed the latest (min v0.75.1) [extended version of Hugo](https://github.com/gohugoio/hugo/releases)*. You may need to scroll down a bit to see extended versions. Alternatively, you may see installation steps from [Hugo's official docs](https://gohugo.io/getting-started/installing/).
 
 If you don't have or can't have extended version of Hugo installed, copy the resources folder from theme to root of your Hugo website directory. Hugo autodetects required files, and uses them.
 
 ## Getting up and running
 
-Read the [prerequisites](#prerequisites) above and verify you're using the extended version of Hugo. There are at least two ways of quickly getting started with Hugo and the VMware Clarity theme:
+Read the [prerequisites](#prerequisites) above and verify you're using the extended version of Hugo. There are at least two ways of quickly getting started with Hugo and the Vibrant Shadows theme:
 
 ### Setting up new Hugo website
 
@@ -31,7 +32,7 @@ Simply add the repo to your theme option in `config.yaml`:
 
 ```yaml
 theme:
-  - github.com/Softorage/gohugo-theme-ananke
+  - github.com/Softorage/HugoTheme-VibrantShadows
 ```
 
 #### 2. As Git Submodule
@@ -40,8 +41,8 @@ Inside the folder of your Hugo site run:
 
 ```bash
 git init # to initiate git if it isn't already
-git submodule add https://github.com/Softorage/gohugo-theme-ananke.git themes/ananke # add theme as a git submodule
-cp -a themes/hugo-shadows/exampleSite/* . # we currently have Hugo Basic Example as our `exampleSite` 
+git submodule add https://github.com/Softorage/HugoTheme-VibrantShadows.git themes/vibrant-shadows # add theme as a git submodule
+cp -a themes/vibrant-shadows/exampleSite/* . # 
 ```
 
 Then run
@@ -52,11 +53,13 @@ hugo server
 
 And, we're done!
 
+After setting up the theme, copy the `postcss.config.js` file to the rrot of your Hugo Website directory. We also recommend creating a `package.json` file in your Hugo Website directory.
+
 ### Using boilerplate provided
 
-1. Copy exampleSite folder provided.
+1. Copy exampleSite folder provided, and move into this folder (open this folder).
 2. Then run `hugo server` in terminal.
 
 And, we're done!
 
-Once set, jump over to the `config.yaml` file and start [configuring](/post/configuration/) your site.
+Once set, jump over to the `config.yaml` file and start [configuring](/post/configuration) your site.