diff options
Diffstat (limited to 'exampleSite/config.yaml')
| -rw-r--r-- | exampleSite/config.yaml | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml new file mode 100644 index 0000000..becf747 --- /dev/null +++ b/exampleSite/config.yaml @@ -0,0 +1,150 @@ +# this configuration file shows all the configuration options supported by 'Shadows' theme by Softorage, with explaining comments. All the options are set to default values. + +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 © 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" +# 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: + tag: "tags" + +# Allow HTML in markdown to be rendered, for social platform list in configuration options +markup: + goldmark: + renderer: + unsafe: true + tableOfContents: + endLevel: 4 + ordered: true + startLevel: 2 + +# with this, Hugo notes some stats about website, which are then used by CSS processors +build: + writeStats: true + +# 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: "#" + 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: "Softorage" # website-wide author | required + footerMessage: "Vibrant Shadows by Softorage" # text shown in footer above footer links | optional + tagline: "Make it the way you like!" # shown in website title on homepage and also used in seo | required + description: "An insanely customizable, extremely lightweight and ridiculously fast 'Blog Theme' for Hugo." # 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: "Vibrant Shadows" # 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: "top" # 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. 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="/assets/favicon/apple-touch-icon.png"> + <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon/favicon-32x32.png"> + <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon/favicon-16x16.png"> + <link rel="manifest" href="/assets/favicon/site.webmanifest"> + <link rel="mask-icon" href="/assets/favicon/safari-pinned-tab.svg" color="#525252"> + <link rel="icon" href="/assets/favicon/favicon.ico" type="image/x-icon"> + <link rel="shortcut icon" href="/assets/favicon/favicon.ico" type="image/x-icon"> + <meta name="apple-mobile-web-app-title" content="ExampleBlog"> + <meta name="application-name" content="ExampleBlog"> + <meta name="msapplication-TileColor" content="#fff6f8"> + <meta name="msapplication-config" content="/assets/favicon/browserconfig.xml"> + 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: "Softorage" # 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 + 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' |