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

github.com/Softorage/HugoTheme-VibrantShadows.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSanmayJoshi <sanmaycjoshi@gmail.com>2020-10-17 13:32:02 +0300
committerSanmayJoshi <sanmaycjoshi@gmail.com>2020-10-17 13:32:02 +0300
commitffb79af17e173554c85fa623d1d97c1a2d1bed35 (patch)
tree9589616a84aa89ce7c4a7cdc91543df7c90e595d /exampleSite/content
parent90c5fb0e35713eb7224e39730a2a82b6f2c551d5 (diff)
Following changes:
* Minor correction in README * Updated exapleSite with new post structure and updated posts * Fixed: content pane in a post overlaps the content * Added tags in theme.toml * Improved the 'postMeta' section in a post's single layout
Diffstat (limited to 'exampleSite/content')
-rw-r--r--exampleSite/content/post/Additional info.md5
-rw-r--r--exampleSite/content/post/Example config.yaml.md201
-rw-r--r--exampleSite/content/post/Getting Started.md24
-rw-r--r--exampleSite/content/post/Hugo's built-in global configuration.md138
-rw-r--r--exampleSite/content/post/Page configuration.md113
-rw-r--r--exampleSite/content/post/Theme's custom global configuration.md (renamed from exampleSite/content/post/Configuration.md)243
6 files changed, 479 insertions, 245 deletions
diff --git a/exampleSite/content/post/Additional info.md b/exampleSite/content/post/Additional info.md
index 2c20e80..fca58de 100644
--- a/exampleSite/content/post/Additional info.md
+++ b/exampleSite/content/post/Additional info.md
@@ -8,7 +8,6 @@ date: "2020-09-30"
We share some additional information about this theme, that may be relevant.
<!--more-->
-
## Built with
* Hugo
@@ -17,9 +16,11 @@ We share some additional information about this theme, that may be relevant.
## Contributing
+Anyone contributing, benefits equally from others' contributions.
+
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.
+If you like our work & find it useful, consider to star on GitHub. We are on [Facebook](https://www.facebook.com/Softorage/), [Twitter](https://twitter.com/Softorage) and [Instagram](https://www.instagram.com/softorage/), you can follow us there too! It really motivates us!
## License
diff --git a/exampleSite/content/post/Example config.yaml.md b/exampleSite/content/post/Example config.yaml.md
new file mode 100644
index 0000000..ec1e3d8
--- /dev/null
+++ b/exampleSite/content/post/Example config.yaml.md
@@ -0,0 +1,201 @@
+---
+title: "Configuration options in the theme"
+author: "Sanmay Joshi"
+description: "An example config.yaml file relevant to Vibrant Shadows Hugo theme."
+tags: ["configuration", "customize", "settings"]
+date: "2020-09-30"
+---
+An example configuration file (config.yaml), which shows all the configuration options supported by 'Vibrant Shadows' theme by Softorage, with explaining comments.
+
+<!--more-->
+
+```yaml
+# this configuration file shows all the configuration options supported by 'Vibrant Shadows' theme by Softorage, with explaining comments.
+
+baseURL: "https://example.com/" # url address of the website | required
+title: "ExampleBlog" # title of the site; usually same as brand name | required
+# author: "The Great Authors" # we won't be using site.Authors till this parameter is finalised. see: https://github.com/gohugoio/hugo/issues/3088
+copyright: "Copyright &#169; 2020 ExampleBlog. 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: "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`)
+
+# taxonomies as per Hugo's taxonomy feature
+taxonomies:
+ tag: "tags"
+ category: "categories"
+ series: "series"
+
+# menu as per Hugo's menu feature
+menu:
+ main:
+ - identifier: "about" # different for all menu entries, useful especially when menu name coincides
+ name: "About" # shown on website/blog
+ url: "/about/" # user is taken to this url when user clicks on menu item
+ weight: 10 # used to sort menu items by weight
+ - identifier: "sub-about"
+ name: "Sub About"
+ url: "/sub-about/"
+ parent: "about"
+ weight: 1
+
+# with this, Hugo notes some stats about website, which are then used by CSS processors, like PostCSS
+build:
+ writeStats: true
+
+# All privacy settings: https://gohugo.io/about/hugo-and-gdpr/#all-privacy-settings
+# Explanations to all privacy settings: https://gohugo.io/about/hugo-and-gdpr/#the-privacy-settings-explained
+privacy:
+ disqus:
+ disable: "false"
+ googleAnalytics:
+ anonymizeIP: "true" # '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
+
+# Here starts our customization
+params:
+ social:
+ profiles: # social platforms you are present on. see supported ones here | highly recommended
+ facebook: "#"
+ twitter: "#"
+ github: "#"
+ gitlab: "#"
+ steam: "#"
+ instagram: "#"
+ youtube: "#"
+ pinterest: "#"
+ linkedin: "#"
+ reddit: "#"
+ flickr: "#"
+ deviantart: "#"
+ vk: "#"
+ mastodon: "#"
+ bandcamp: "#"
+ tumblr: "#"
+ medium: "#"
+ wikipedia: "#"
+ telegram: "#"
+ # coming soon:
+ paypal: "#"
+ slack: "#"
+ twitch: "#"
+ stackoverflow: "#"
+ shutterstock: "#"
+ soundcloud: "#"
+ codepen: "#"
+ share: ["facebook", "twitter", "linkedin", "telegram", "whatsapp", "reddit", "email"] # accepts array of values: "facebook", "twitter", "linkedin", "whatsapp", "reddit", "email". just type the name of those you want you articles to be able to be shared on
+ meta:
+ author: "The Great Authors" # website-wide author | required
+ footerMessage: "Awesome footer message" # text (HTML supported) shown in footer above footer links | optional
+ tagline: "A Really Catchy Tagline" # shown in website title on homepage and also used in seo | required
+ description: "A really great description!" # should include brand name | character length: 50 to 160 characters
+ contentLicense: "CC-BY-SA-3.0" # cc-by-3.0, etc or 'All right reserved.' should also be same as the one in copyright above
+ titleSeparator: " | " # used in website/blog title, to separate (say) page title from website/blog title | default: " | "
+ attribution: "enable" # attribute Hugo team for awesome software and Softorage for great theme | default: "enable"
+ brand:
+ name: "ExampleBlog" # brand name (Samy's blog), usually just one word that is name of the brand | required | no default
+ logo: "" # path (preferably relative path) to brand's good resolution logo | required | no default
+ color: "#7d1fa5" # color to be shown for brand name on navbar on scroll | required | no default
+ navbar: ["logo", "name"] # accepts array of values: "logo", "name" | this configuration shows brand 'log' & brand 'name' on navbar | optional | default: ["logo", "name"]
+ theme: # optional
+ nav: "#ffffff" # navbar's background color | optional | default: "#ffffff"
+ antinav: "#000000" # a color in good contrast to nav | optional | default: "#000000"
+ mat: "#f9f9f9" # background color forcards (not of cards) | optional | default: "#f9f9f9"
+ clr1: "#7d1fa5" # color-1 of gradient | optional | default: "#7d1fa5"
+ clr2: "#6d19fc" # color-2 of gradient | optional | default: "#6d19fc"
+ borders: "rounded" # accepts value: rounded/square | what kind of borders do you like for elements, like buttons | default: "rounded"
+ position: # optional
+ social:
+ profiles: "footer" # accepts value: navbar/footer | may use 'navbar' if number of items in main menu and social profiles are minimal, otherwise 'footer' is recommended | default: "footer"
+ share: "bottom" # top/bottom | no default
+ navbarMenu: "right" # accepts value: right/left | decides the position of main menu on navbar | default: "right"
+ postMeta: #
+ readingTime:
+ summary: "top" # values: top/bottom, no default
+ content: "top" # accepts array of values: "summary", "content" | determines 1. where should 'reading time for a post' appear: wherever summary of post is shown eg, homepage; on the post itself. 2. how should it appaer: at top or at bottom. this configuration shows "reading time" when 'summary' is shown & in 'blog post' | optional | no default
+ wordCount:
+ summary: "top" # values: top/bottom, no default
+ content: "top" # accepts array of values: "summary", "content" | this configuration shows "word count" when 'summary' is shown & in 'blog post' | optional | no default
+ author:
+ summary: "top" # values: top/bottom, no default
+ content: "top" # accepts array of values: "summary", "content" | this configuration shows "author" when 'summary' is shown & in 'blog post' | optional | no default
+ lastUpdated:
+ summary: "top" # values: top/bottom, no default
+ content: "top" # accepts array of values: "summary", "content" | this configuration shows "last updated date" when 'summary' is shown & in 'blog post' | optional | no default
+ tags:
+ summary: "top" # values: top/bottom, no default
+ content: "bottom" # accepts array of values: "summary", "content" | this configuration shows "tags" when 'summary' is shown & in 'blog post' | optional | no default
+ font:
+ general:
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ heading:
+ list: ["h1"] # accepts array of values: "h1", "h2", "h3", "h4", "h5", "h6" | default: ["h1"]
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ description:
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ brand:
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ footer:
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ copyright:
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ postMeta:
+ family: "Lato" # must match to a css font-family | default: "Lato"
+ #cdnLink: "" # a link tag for font other than Lato and Roboto | recommended
+ faviconTags: | # just copy paste all the tags here (Hugo templating supported). Also, ensure that you have "purpose": "maskable" set for one icon in your site.webmanifest file (helps for pwa). Use https://realfavicongenerator.net, it's great
+ <link rel="apple-touch-icon" sizes="180x180" href="{{ site.BaseURL }}/assets/favicon/apple-touch-icon.png">
+ <link rel="icon" type="image/png" sizes="32x32" href="{{ site.BaseURL }}/assets/favicon/favicon-32x32.png">
+ <link rel="icon" type="image/png" sizes="16x16" href="{{ site.BaseURL }}/assets/favicon/favicon-16x16.png">
+ <link rel="manifest" href="{{ site.BaseURL }}/assets/favicon/site.webmanifest">
+ <link rel="mask-icon" href="{{ site.BaseURL }}/assets/favicon/safari-pinned-tab.svg" color="#7817c4">
+ <link rel="icon" href="{{ site.BaseURL }}/assets/favicon/favicon.ico" type="image/x-icon">
+ <link rel="shortcut icon" href="{{ site.BaseURL }}/assets/favicon/favicon.ico" type="image/x-icon">
+ <meta name="apple-mobile-web-app-title" content="Vibrant Shadows Theme">
+ <meta name="application-name" content="Vibrant Shadows Theme">
+ <meta name="msapplication-TileColor" content="#ffffff">
+ <meta name="theme-color" content="#ffffff">
+ seo:
+ switch: "on" # accepts value: on/off | decide whether you want all the good seo meta tags | default: on
+ twitter:
+ card: "enable" # accepts value: enable/disable | good for seo | default: enable
+ handle: "Great" #twitter handle website-wide author, without @
+ facebook:
+ openGraph: "enable" # accepts value: enable/disable | good for seo | default: enable
+ #appID: "" # facebook App ID
+ jsonLD: "enable" # accepts value: enable/disable | good for seo | default: enable
+ speedMode: "disable" # accepts value: enable/disable | enabling "Speed Mode" would make the website/blog extremely fast and lightweight, providing a snappy experience to website/blog visitors. "Speed Mode" utilises *PostCSS* via *Hugo's Asset Pipeline*. note that, "Speed Mode" works in *production environment* only. since many Hugo users do not have Hugo's extended version, this option is disabled by default. | default: disable
+ cookieConsent: # we use OSANO Cookie Consent solution
+ switch: "off" # accepts: on/off | decide whether you want to show a cookie consent dialog to your users | default: "off"
+ type: "opt-in" # accepts: opt-in/opt-out/none | 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. Refrain from using none, unless you have zero customers from EU or similar countries with privacy protecting laws. | no default
+ revokable: true # a button to revoke cookie consent appears when user hover in bottom area of the screen, regardless whether user's country requires revertable cookie consent | default: true
+ colors:
+ banner:
+ background: "#ffffff" # HEX | default: theme.nav
+ text: "#000000" # HEX | default: theme.antinav
+ button:
+ background: "#6d19fc" # HEX | default: theme.clr2
+ text: "#ffffff" # HEX | default: theme.nav
+ content: # change the links below to appropriate url addresses
+ message: | # no default
+ 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" # text on the button that dismisses the popup/banner | default: "Close"
+ linkText: "Learn more" # this text appears after the message and is hyperlinked | default: "Learn more"
+ linkURL: "/legal/privacy-policy/" # url of location where user should be directed when they click "Learn more".
+ allow: "Allow" # text on the button that allows cookies | default: "Allow"
+ deny: "Decline" # text on the button that denies cookies | default: "Decline"
+ policy: "Cookie Consent" # text that appears on the button, when user's country requires revokable cookie consent | default: "Cookie Consent"
+ userExperience:
+ googleAnalyticsLoading: "sync" # accepts value: sync/async | determines whether Google Analytics JavaScript file loads 'Synchronously' or 'Asynchronously' | optional | default: "sync"
+ mainSections: ["post"] # required, https://gohugo.io/functions/where/#mainsections
+ #customVerification:
+ #myWOT: "ba8579f668r8w3g62503" # content for meta tag to verify your website on 'Web Of Trust'
+```
diff --git a/exampleSite/content/post/Getting Started.md b/exampleSite/content/post/Getting Started.md
index 55eef3e..453a39b 100644
--- a/exampleSite/content/post/Getting Started.md
+++ b/exampleSite/content/post/Getting Started.md
@@ -13,7 +13,7 @@ It's very easy to get started with Vibrant Shadows. How? Read on.
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.
+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. Note that it might make your website slightly slow to load.
## Getting up and running
@@ -26,14 +26,16 @@ hugo new site yourSiteName # generate a new Hugo site if you don't already have
cd yourSiteName # move in to the Hugo website's directory
```
-#### 1. As a Hugo Module (recommended)
+#### 1. As a Hugo theme (recommended)
-Simply add the repo to your theme option in `config.yaml`:
-
-```yaml
-theme:
- - github.com/Softorage/HugoTheme-VibrantShadows
-```
+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: "HugoTheme-VibrantShadows"
+ ```
#### 2. As Git Submodule
@@ -41,8 +43,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
@@ -53,7 +55,7 @@ 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.
+If you have extended version of Hugo installed, copy the `postcss.config.js` file to the root of your Hugo Website directory after setting up the theme. We also recommend creating a `package.json` file in your Hugo Website directory.
### Using boilerplate provided
diff --git a/exampleSite/content/post/Hugo's built-in global configuration.md b/exampleSite/content/post/Hugo's built-in global configuration.md
new file mode 100644
index 0000000..cd9bea5
--- /dev/null
+++ b/exampleSite/content/post/Hugo's built-in global configuration.md
@@ -0,0 +1,138 @@
+---
+title: "Hugo's built-in global configurations"
+author: "Sanmay Joshi"
+description: "Get to know the Hugo's built-in configurations relevant to Vibrant Shadows Hugo theme."
+tags: ["configuration", "customize", "settings"]
+date: "2020-09-30"
+---
+Options that Hugo has built-in and are relevant 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).
+
+<!--more-->
+
+**Global Parameters (site-level):**
+
+These options set global values that some pages or all pages in the site use by default.
+
+## Hugo's built-in global parameters
+
+1. **BaseURL** *(Type: String | Accepts value: URL | Required | No default)*
+
+ baseURL is the URL of the website or blog.
+
+ Example:
+ ```yaml
+ baseurl: "https://example.com/"
+ ```
+2. **Title** *(Type: String | Accepts value: Text | Required | No default)*
+
+ It is the title of the website or blog. Title is usually same as brand name.
+
+ Example:
+ ```yaml
+ title: "ExampleBlog"
+ ```
+3. **Author** *(Type: String | Accepts value: Text | Required | No default)*
+
+ We won't be using `site.Authors` till this parameter is finalised. See [here](https://github.com/gohugoio/hugo/issues/3088).
+ <!--It stores website-wide author(s).
+
+ Example:
+ ```yaml
+ author: "The Great Authors"
+ ```
+ #name: https://gohugo.io/templates/rss/#configure-rss
+ #email: "" # author's email; used in default rss template: https://gohugo.io/templates/rss/#configure-rss | optional-->
+4. **Copyright** *(Type: String | Accepts value: Text | Optional | No default)*
+
+ It is the copyright text. Due consideration should be given to 'brandName or title' and 'contentLicense' specified in configuration file. Note that it isn't used in footer, but only [in defualt RSS template](https://gohugo.io/templates/rss/#configure-rss).
+
+ Example:
+ ```yaml
+ copyright: "Copyright &#169; 2020 ExampleBlog. All rights reserved."
+ ```
+5. **Language Code** *(Type: String | Accepts value: Text | Recommended | No default)*
+
+ It stores the language code for the website or blog.
+
+ Example:
+ ```yaml
+ languageCode: "en-us"
+ ```
+6. **Theme** *(Type: String | Accepts value: Text | Required | No default)*
+
+ This is the name of the theme you are using.
+
+ Example:
+ ```yaml
+ theme: "HugoTheme-VibrantShadows"
+ ```
+7. **Google Analytics** *(Type: String | Accepts value: Alphanumeric | Optional | No default)*
+
+ It is your Google Analytics ID, if any. Respecting your preference from 'privacy', and 'params -> user_experience' configuration, 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`)
+
+ Example:
+ ```yaml
+ googleAnalytics: "UA-123456789-0"
+ ```
+8. **Disqus Shortname** *(Type: String | Accepts value: Alphanumeric | Optional | No default)*
+
+ It is your Disqus Shortname, if any. 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`)
+
+ Example:
+ ```yaml
+ disqusShortname: "yourdiscussshortname"
+ ```
+9. **Taxonomies** *(Type: Map/Dict/Object | Accepts value: - | Optional | Default: Tags & Categories)*
+
+ This feature allows to define custom taxonomies for post/page management.
+
+ Example:
+ ```yaml
+ taxonomies:
+ tag: "tags" # when defining custom taxonomies, we need to redefine even the default taxonomies if we wish to keep them, hence we have redefined 'tags'. see here: https://gohugo.io/content-management/taxonomies#example-adding-a-custom-taxonomy-named-series
+ category: "categories" # redefined 'categories'
+ series: "series" # defined a custom taxonomy, 'series'
+ ```
+10. **Menus** *(Type: Map/Dict/Object | Accepts value: - | Optional | No default)*
+
+ These are the menus that are used by users to navigate the website/blog. An example would be 'main' menu, which usually resides on navbar.
+
+ Example:
+ ```yaml
+ menu:
+ main:
+ - identifier: "about" # different for all menu entries, useful especially when menu name coincides
+ name: "About" # shown on website/blog
+ url: "/about/" # user is taken to this url when user clicks on menu item
+ weight: 10 # used to sort menu items by weight
+ - identifier: "sub-about"
+ name: "Sub About"
+ url: "/sub-about/"
+ parent: "about"
+ weight: 1
+ ```
+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).
+
+ Example:
+ ```yaml
+ privacy:
+ disqus:
+ disable: "false" # | default: false
+ googleAnalytics:
+ 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
+ ```
+
diff --git a/exampleSite/content/post/Page configuration.md b/exampleSite/content/post/Page configuration.md
new file mode 100644
index 0000000..64e06e3
--- /dev/null
+++ b/exampleSite/content/post/Page configuration.md
@@ -0,0 +1,113 @@
+---
+title: "Page configuration options in the theme"
+author: "Sanmay Joshi"
+description: "Get to know all the page-level configuration relevant to Vibrant Shadows Hugo theme."
+tags: ["configuration", "customize", "settings"]
+date: "2020-09-30"
+---
+'Page paremeters' relate to the particular content file in whose front-matter they are defined.
+
+<!--more-->
+
+## Page Parameters
+
+These options can be set from a page [front-matter](https://gohugo.io/content-management/front-matter#readout) or via [archetypes](https://gohugo.io/content-management/archetypes/#readout) (i.e. when you create a new content file via `hugo new` command).
+
+1. **Title** *(Type: String | Accepts value: Text | Required)*
+
+ It is the title of the current page/post you are writing.
+
+ Example:
+ ```yaml
+ title: "A post that takes you into space"
+ ```
+2. **Description** *(Type: String | Accepts value: Text | Required)*
+
+ It is the description of the current page/post. Recommended character length: 50 to 160
+
+ Example:
+ ```yaml
+ description: "A short yet descriptive text that relates to this post."
+ ```
+3. **Date** *(Type: String | Accepts value: Date | Required)*
+
+ It is the date on which current page/post is published.
+
+ Example:
+ ```yaml
+ date: "2021-04-26" # YYYY-MM-DD
+ ```
+4. **Last Modified** *(Type: String | Accepts value: Date | Required)*
+
+ It is the date on which current post was last modified.
+
+ Example:
+ ```yaml
+ lastmod: "2021-04-29"
+ ```
+5. **Tags/Categories/Custom-Taxonomy** *(Type: Array/String | Accepts value: Text | Recommended)*
+
+ You can manage and organise you posts based on tags, categories or any other custom taxonomy.
+
+ Example:
+ ```yaml
+ tags: ["great post", "awesome"] # multiple elements
+ categories: "category" # single element
+ ```
+6. **Image** *(Type: String | Accepts value: Path to Image | Recommended)*
+
+ You can specify path to an image dedicated to current post. This image is used to optimize the display of content when shared on social media.
+
+ Example:
+ ```yaml
+ image: "/images/post-1.png"
+ ```
+7. **Author** *(Type: String | Accepts value: Text | Recommended)*
+
+ It is the name of the author of the current post.
+
+ Example:
+ ```yaml
+ author: "Great Author"
+ ```
+8. **Author Twitter Handle** *(Type: String | Accepts value: Text | Recommended)*
+
+ It is the Twitter handle of the author of the current post, without '@'. This option is theme specific.
+
+ Example:
+ ```yaml
+ author_twitter: "Gr8Authr" # this is just an example
+ ```
+9. **Draft** *(Type: Boolean | Accepts value: true/false | Optional)*
+
+ If it is set to `true`, the content will not be rendered unless the `--buildDrafts` flag is passed to the `hugo` command.
+
+ Example:
+ ```yaml
+ draft: true
+ ```
+10. **Table of Contents** *(Type: boolean/String | Accepts value: true/false | Optional)*
+
+ If set to `false`, *Table of Content* for current post will not be rendered.
+
+ Example:
+ ```yaml
+ toc: false
+ ```
+11. **Aliases** *(Type: Array | Accepts value: Relative URL | Optional)*
+
+ It stores other URLs (in relative form) - usually older URLs for current post - which you would like to redirect to current post.
+
+ Example:
+ ```yaml
+ aliases: ["/posts/my-original-url/", "/2010/01/01/even-earlier-url.html"]
+ ```
+12. **URL** *(Type: String | Accepts value: Relative URL | Optional)*
+
+ If you want to specify a custom URL for this post other than the one automatically generated by hugo based on content directory structure, you can specify it in this parameter.
+
+ Example:
+ ```yaml
+ url: "/custom/url/"
+ ```
+
diff --git a/exampleSite/content/post/Configuration.md b/exampleSite/content/post/Theme's custom global configuration.md
index 1b410d9..d56d702 100644
--- a/exampleSite/content/post/Configuration.md
+++ b/exampleSite/content/post/Theme's custom global configuration.md
@@ -1,5 +1,5 @@
---
-title: "Configuration options in the theme"
+title: "Custom 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"]
@@ -9,134 +9,11 @@ Here, we will mainly see settings that are unique to this theme. If something is
<!--more-->
-## Global Parameters
+**Global Parameters (site-level):**
These options set global values that some pages or all pages in the site use by default.
-### Hugo's built-in parameters
-
-1. **BaseURL** *(Type: String | Accepts value: URL | Required | No default)*
-
- baseURL is the URL of the website or blog.
-
- Example:
- ```yaml
- baseurl: "https://example.com/"
- ```
-2. **Title** *(Type: String | Accepts value: Text | Required | No default)*
-
- It is the title of the website or blog. Title is usually same as brand name.
-
- Example:
- ```yaml
- title: "ExampleBlog"
- ```
-3. **Author** *(Type: String | Accepts value: Text | Required | No default)*
-
- We won't be using `site.Authors` till this parameter is finalised. See [here](https://github.com/gohugoio/hugo/issues/3088).
- <!--It stores website-wide author(s).
-
- Example:
- ```yaml
- author: "The Great Authors"
- ```
- #name: https://gohugo.io/templates/rss/#configure-rss
- #email: "" # author's email; used in default rss template: https://gohugo.io/templates/rss/#configure-rss | optional-->
-4. **Copyright** *(Type: String | Accepts value: Text | Optional | No default)*
-
- It is the copyright text. Due consideration should be given to 'brandName or title' and 'contentLicense' specified in configuration file. Note that it isn't used in footer, but only [in defualt RSS template](https://gohugo.io/templates/rss/#configure-rss).
-
- Example:
- ```yaml
- copyright: "Copyright &#169; 2020 ExampleBlog. All rights reserved."
- ```
-5. **Language Code** *(Type: String | Accepts value: Text | Recommended | No default)*
-
- It stores the language code for the website or blog.
-
- Example:
- ```yaml
- languageCode: "en-us"
- ```
-6. **Theme** *(Type: String | Accepts value: Text | Required | No default)*
-
- This is the name of the theme you are using.
-
- Example:
- ```yaml
- theme: "HugoTheme-VibrantShadows"
- ```
-7. **Google Analytics** *(Type: String | Accepts value: Alphanumeric | Optional | No default)*
-
- It is your Google Analytics ID, if any. Respecting your preference from 'privacy', and 'params -> user_experience' configuration, 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`)
-
- Example:
- ```yaml
- googleAnalytics: "UA-123456789-0"
- ```
-8. **Disqus Shortname** *(Type: String | Accepts value: Alphanumeric | Optional | No default)*
-
- It is your Disqus Shortname, if any. 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`)
-
- Example:
- ```yaml
- disqusShortname: "yourdiscussshortname"
- ```
-9. **Taxonomies** *(Type: Map/Dict/Object | Accepts value: - | Optional | Default: Tags & Categories)*
-
- This feature allows to define custom taxonomies for post/page management.
-
- Example:
- ```yaml
- taxonomies:
- tag: "tags" # when defining custom taxonomies, we need to redefine even the default taxonomies if we wish to keep them, hence we have redefined 'tags'. see here:
- category: "categories" # redefined 'categories'
- series: "series" # defined a custom taxonomy, 'series'
- ```
-10. **Menus** *(Type: Map/Dict/Object | Accepts value: - | Optional | No default)*
-
- These are the menus that are used by users to navigate the website/blog. An example would be 'main' menu, which usually resides on navbar.
-
- Example:
- ```yaml
- menu:
- main:
- - identifier: "about" # different for all menu entries, useful especially when menu name coincides
- name: "About" # shown on website/blog
- url: "/about/" # user is taken to this url when user clicks on menu item
- weight: 10 # used to sort menu items by weight
- - identifier: "sub-about"
- name: "Sub About"
- url: "/sub-about/"
- parent: "about"
- weight: 1
- ```
-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).
-
- Example:
- ```yaml
- privacy:
- disqus:
- disable: "false" # | default: false
- googleAnalytics:
- 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
+## Vibrant Shadow's custom parameters
All these properties come under Hugo's built-in property, `params`.
@@ -247,8 +124,8 @@ Let's see them one by one.
Example:
```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.
@@ -256,7 +133,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.
@@ -305,7 +182,7 @@ Let's see them one by one.
It's color-1 in the hero gradient. It is used throughout the theme.
5. **Color-2** *(Type: String | Accepts value: HEX/RGBA | Optional | Default: "#6d19fc")*
- It's color-1 in the hero gradient. It is used throughout the theme.
+ It's color-2 in the hero gradient. It is used throughout the theme.
6. **Borders** *(Type: String | Accepts value: rounded/square | Optional | Default: "rounded")*
Here, specify what kind of borders do you like for elements, like buttons.
@@ -448,6 +325,9 @@ Let's see them one by one.
4. **JSON-LD** *(Type: String | Accepts value: enable/disable | Optional | Default: "enable")*
Improves ability of search engines to better index and understand the website/blog. Helps in SEO optimization.
+ 5. **Speed Mode** *(Type: String | Accepts value: enable/disable | Highly Recommended | Default: "disable")*
+
+ Enabling "Speed Mode" would make the website/blog extremely fast and lightweight, providing a snappy experience to website/blog visitors. "Speed Mode" utilises *PostCSS* via *Hugo's Asset Pipeline*. Note that, "Speed Mode" works in *production environment* only. Since many Hugo users do not have Hugo's extended version, this option is disabled by default.
Example:
```yaml
@@ -460,6 +340,7 @@ Let's see them one by one.
openGraph: "enable"
appID: "170405085280305" # it is just for illustration purpose
jsonLD: "enable"
+ speedMode: "enable"
```
10. **Cookie Consent** *(Type: Map/Dict/Object | Accepts value: - | Optional)*
@@ -551,105 +432,3 @@ Let's see them one by one.
```yaml
mainSections: ["post"]
```
-
-## Page Parameters
-
-'Page paremeters' relate to the particular content file in whose front-matter they are defined. These options can be set from a page [front-matter](https://gohugo.io/content-management/front-matter#readout) or via [archetypes](https://gohugo.io/content-management/archetypes/#readout) (i.e. when you create a new content file via `hugo new` command).
-
-1. **Title** *(Type: String | Accepts value: Text | Required)*
-
- It is the title of the current page/post you are writing.
-
- Example:
- ```yaml
- title: "A post that takes you into space"
- ```
-2. **Description** *(Type: String | Accepts value: Text | Required)*
-
- It is the description of the current page/post. Recommended character length: 50 to 160
-
- Example:
- ```yaml
- description: "A short yet descriptive text that relates to this post."
- ```
-3. **Date** *(Type: String | Accepts value: Date | Required)*
-
- It is the date on which current page/post is published.
-
- Example:
- ```yaml
- date: "2021-04-26" # YYYY-MM-DD
- ```
-4. **Last Modified** *(Type: String | Accepts value: Date | Required)*
-
- It is the date on which current post was last modified.
-
- Example:
- ```yaml
- lastmod: "2021-04-29"
- ```
-5. **Tags/Categories/Custom-Taxonomy** *(Type: Array/String | Accepts value: Text | Recommended)*
-
- You can manage and organise you posts based on tags, categories or any other custom taxonomy.
-
- Example:
- ```yaml
- tags: ["great post", "awesome"] # multiple elements
- categories: "category" # single element
- ```
-6. **Image** *(Type: String | Accepts value: Path to Image | Recommended)*
-
- You can specify path to an image dedicated to current post. This image is used to optimize the display of content when shared on social media.
-
- Example:
- ```yaml
- image: "/images/post-1.png"
- ```
-7. **Author** *(Type: String | Accepts value: Text | Recommended)*
-
- It is the name of the author of the current post.
-
- Example:
- ```yaml
- author: "Great Author"
- ```
-8. **Author Twitter Handle** *(Type: String | Accepts value: Text | Recommended)*
-
- It is the Twitter handle of the author of the current post, without '@'.
-
- Example:
- ```yaml
- author_twitter: "Gr8Authr" # this is just an example
- ```
-9. **Draft** *(Type: Boolean | Accepts value: true/false | Optional)*
-
- If it is set to `true`, the content will not be rendered unless the `--buildDrafts` flag is passed to the `hugo` command.
-
- Example:
- ```yaml
- draft: true
- ```
-10. **Table of Contents** *(Type: boolean/String | Accepts value: true/false | Optional)*
-
- If set to `false`, *Table of Content* for current post will not be rendered.
-
- Example:
- ```yaml
- toc: false
- ```
-11. **Aliases** *(Type: Array | Accepts value: Relative URL | Optional)*
-
- It stores other URLs (in relative form) - usually older URLs for current post - which you would like to redirect to current post.
-
- Example:
- ```yaml
- aliases: ["/posts/my-original-url/", "/2010/01/01/even-earlier-url.html"]
- ```
-12. **URL** *(Type: String | Accepts value: Relative URL | Optional)*
-
- If you want to specify a custom URL for this post other than the one automatically generated by hugo based on content directory structure, you can specify it in this parameter.
-
- Example:
- ```yaml
- url: "/custom/url/"
- ```