From fb3fb4d3257ecea909e3a9aaca2ceb924868d3bc Mon Sep 17 00:00:00 2001 From: Aditya Telange <21258296+adityatelange@users.noreply.github.com> Date: Fri, 10 Jun 2022 21:49:13 +0530 Subject: [PATCH] Update docs from wiki and prettify --- .../posts/papermod/papermod-features/index.md | 121 +++++---- content/posts/papermod/papermod-icons.md | 165 +++++++----- .../posts/papermod/papermod-installation.md | 248 +++++++++--------- content/posts/papermod/papermod-variables.md | 106 ++++---- 4 files changed, 346 insertions(+), 294 deletions(-) diff --git a/content/posts/papermod/papermod-features/index.md b/content/posts/papermod/papermod-features/index.md index 6692ac15..bfc4c430 100644 --- a/content/posts/papermod/papermod-features/index.md +++ b/content/posts/papermod/papermod-features/index.md @@ -10,9 +10,9 @@ author: "Aditya Telange" ### Intro -- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.** +- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.** -- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary. +- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary. --- @@ -20,9 +20,9 @@ author: "Aditya Telange" The following is enabled by default -- [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible. -- [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset -- [fingerprint/integrity](https://gohugo.io/hugo-pipes/fingerprint/) check. +- [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible. +- [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset +- [fingerprint/intergity](https://gohugo.io/hugo-pipes/fingerprint/) check. --- @@ -30,9 +30,9 @@ The following is enabled by default ```yml params: - # defaultTheme: light - # defaultTheme: dark - defaultTheme: auto # to switch between dark or light according to browser theme + # defaultTheme: light + # defaultTheme: dark + defaultTheme: auto # to switch between dark or light according to browser theme ``` @@ -86,7 +86,6 @@ layout: "archives" url: "/archives/" summary: archives --- - ``` **Note:** Archives Layout does not support Multilingual Month Translations. @@ -122,8 +121,6 @@ params: url: "" ``` -ex. [config.yml#L106](https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.yml#L106) - --- ### Profile Mode @@ -146,15 +143,15 @@ params: imageHeight: 120 # custom size buttons: - name: Archive - url: "/archive" + url: "/archive" - name: Github - url: "https://github.com/" + url: "https://github.com/" socialIcons: # optional - name: "" - url: "" + url: "" - name: "" - url: "" + url: "" ``` --- @@ -167,10 +164,10 @@ Add the following to site config, `config.yml` ```yml outputs: - home: - - HTML - - RSS - - JSON # is necessary + home: + - HTML + - RSS + - JSON # is necessary ``` Create a page with `search.md` in `content` directory with following content @@ -182,8 +179,8 @@ layout: "search" # is necessary # url: "/archive" # description: "Description for Search" summary: "search" +placeholder: "placeholder text in search input box" --- - ``` To hide a particular page from being searched, add it in post's fron't matter @@ -197,9 +194,9 @@ ex: [search.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/ex > Search Page also has Key bindings: > -> - Arrow keys to move up/down the list -> - Enter key (return) or Right Arrow key to Go to highlighted page -> - Escape key to clear searchbox and results +> - Arrow keys to move up/down the list +> - Enter key (return) or Right Arrow key to Go to highlighted page +> - Escape key to clear searchbox and results For Multilingual use `search..md` ex. `search.es.md`. @@ -211,14 +208,14 @@ Refer https://fusejs.io/api/options.html for Options, Add those as shown below. ```yml params: - fuseOpts: - isCaseSensitive: false - shouldSort: true - location: 0 - distance: 1000 - threshold: 0.4 - minMatchCharLength: 0 - keys: ["title", "permalink", "summary", "content"] + fuseOpts: + isCaseSensitive: false + shouldSort: true + location: 0 + distance: 1000 + threshold: 0.4 + minMatchCharLength: 0 + keys: ["title", "permalink", "summary", "content"] ``` --- @@ -235,12 +232,12 @@ In post's page-variables add : ```yml cover: - image: "" - # can also paste direct link from external site - # ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png - alt: "" - caption: "" - relative: false # To use relative path for cover image, used in hugo Page-bundles + image: "" + # can also paste direct link from external site + # ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png + alt: "" + caption: "" + relative: false # To use relative path for cover image, used in hugo Page-bundles ``` When you include images in the [Page Bundle](https://gohugo.io/content-management/page-bundles/), multiple sizes of the image will automatically be provided using the HTML5 `srcset` field. @@ -249,16 +246,16 @@ To reduce generation time and size of the site, you can disable this feature usi ```yml params: - cover: - responsiveImages: false + cover: + responsiveImages: false ``` To enable hyperlinks to the full image size on post pages, use ```yml params: - cover: - linkFullImages: true + cover: + linkFullImages: true ``` --- @@ -271,7 +268,7 @@ to show share buttons add ```yml params: - ShowShareButtons: true + ShowShareButtons: true ``` --- @@ -284,7 +281,7 @@ To show reading time add ```yml Params: - ShowReadingTime: true + ShowReadingTime: true ``` --- @@ -313,7 +310,7 @@ Adds BreadCrumb Navigation above Post's Title to show subsections and Navigation ```yml params: - ShowBreadCrumbs: true + ShowBreadCrumbs: true ``` Can be diabled for particular page's front-matter @@ -322,7 +319,6 @@ Can be diabled for particular page's front-matter --- ShowBreadCrumbs: false --- - ``` --- @@ -335,10 +331,10 @@ For site config use: ```yml Params: - editPost: - URL: "https://github.com//content" - Text: "Suggest Changes" # edit text - appendFilePath: true # to append file path to Edit link + editPost: + URL: "https://github.com//content" + Text: "Suggest Changes" # edit text + appendFilePath: true # to append file path to Edit link ``` Can be modified for individual pages @@ -346,11 +342,10 @@ Can be modified for individual pages ```yml --- editPost: - URL: "https://github.com//content" - Text: "Suggest Changes" # edit text - appendFilePath: true # to append file path to Edit link + URL: "https://github.com//content" + Text: "Suggest Changes" # edit text + appendFilePath: true # to append file path to Edit link --- - ``` The example above would yield the following link for the post file `posts/post-name.md`: @@ -374,7 +369,18 @@ Adds a Previous / Next post suggestion under a single post ```yml params: - ShowPostNavLinks: true + ShowPostNavLinks: true +``` + +--- + +### Code Copy Button + +Adds a `copy` button in code block to copy the code it contains + +```yml +params: + ShowCodeCopyButtons: true ``` --- @@ -387,14 +393,13 @@ To Use multiple authors for a post, in post-variables: --- author: ["Me", "You"] --- - ``` To use Multiple Authors Site-wide, in `config.yml`: ```yml params: - author: ["Me", "You"] + author: ["Me", "You"] ``` --- @@ -411,7 +416,7 @@ also in config add this ```yml params: - comments: true + comments: true ``` read more about this [hugo-comments](https://gohugo.io/content-management/comments/) @@ -436,7 +441,7 @@ t - Theme toggle **Enabled only when `env: production`** -- [Rich Results/Snippets Support](https://support.google.com/webmasters/answer/7506797?hl=en) +- [Rich Results/Snippets Support](https://support.google.com/webmasters/answer/7506797?hl=en) #### Twitter Cards Support diff --git a/content/posts/papermod/papermod-icons.md b/content/posts/papermod/papermod-icons.md index d9bf636d..e0c5cf63 100644 --- a/content/posts/papermod/papermod-icons.md +++ b/content/posts/papermod/papermod-icons.md @@ -11,87 +11,107 @@ draft: true ## Social Icons -| No. | Name | Platform Link | -| --- | --------------- | ------------------------------- | -| 1 | `123rf` | 123rf.com | -| 2 | `adobestock` | stock.adobe.com | -| 3 | `behance` | behance.net | -| 4 | `buymeacoffee` | buymeacoffee.com | -| 5 | `codepen` | codepen.io | -| 6 | `cryptohack` | cryptohack.org | -| 7 | `ctftime` | ctftime.org | -| 8 | `dev` | dev.to | -| 9 | `discogs` | discogs.com | -| 10 | `discord` | discord.com | -| 11 | `dreamstime` | dreamstime.com | -| 12 | `dribbble` | dribbble.com | -| 13 | `email` | - | -| 14 | `facebook` | facebook.com | -| 15 | `flickr` | flickr.com | -| 16 | `freepik` | freepik.com | -| 17 | `gitea` | gitea.io | -| 18 | `github` | github.com | -| 19 | `gitlab` | gitlab.com | -| 20 | `goodreads` | goodreads.com | -| 21 | `hackerone` | hackerone.com | -| 22 | `hackerrank` | hackerrank.com | -| 23 | `hackthebox` | hackthebox.eu | -| 24 | `instagram` | instagram.com | -| 25 | `itchio` | itch.io | -| 26 | `kakaotalk` | kakaocorp.com/service/KakaoTalk | -| 27 | `keybase` | keybase.io | -| 28 | `kofi` | ko-fi.com | -| 29 | `lastfm` | last.fm | -| 30 | `liberapay` | liberapay.com | -| 31 | `linkedin` | linkedin.com | -| 32 | `mastodon` | mastodon.social | -| 33 | `matrix` | matrix.org | -| 34 | `medium` | medium.com | -| 35 | `mixcloud` | mixcloud.com | -| 36 | `nuget` | nuget.org | -| 37 | `paypal` | paypal.com | -| 38 | `qq` | qq.com | -| 39 | `reddit` | reddit.com | -| 40 | `rss` | - | -| 41 | `serverfault` | serverfault.com | -| 42 | `soundcloud` | soundcloud.com | -| 43 | `shutterstock` | shutterstock.com | -| 44 | `slack` | slack.com | -| 45 | `snapchat` | snapchat.com/add | -| 46 | `sourcerer` | sourcerer.io | -| 47 | `spotify` | spotify.com | -| 48 | `stackoverflow` | stackoverflow.com | -| 49 | `steam` | steampowered.com | -| 50 | `telegram` | telegram.org | -| 51 | `twitch` | twitch.tv | -| 52 | `twitter` | twitter.com | -| 53 | `unsplash` | unsplash.com | -| 54 | `xda` | xda-developers.com | -| 55 | `youtube` | youtube.com | -| 56 | `other` | - | +| Name | Platform Link | +| --------------- | ------------------------------- | +| `123rf` | 123rf.com | +| `adobestock` | stock.adobe.com | +| `apple music` | music.apple.com | +| `behance` | behance.net | +| `bilibili` | bilibili.com | +| `bitcoin` | - | +| `buymeacoffee` | buymeacoffee.com | +| `codepen` | codepen.io | +| `cryptohack` | cryptohack.org | +| `ctftime` | ctftime.org | +| `cv` | - | +| `deezer` | deezer.com | +| `dev` | dev.to | +| `discogs` | discogs.com | +| `discord` | discord.com | +| `dreamstime` | dreamstime.com | +| `dribbble` | dribbble.com | +| `email` | - | +| `facebook` | facebook.com | +| `flickr` | flickr.com | +| `freepik` | freepik.com | +| `gitea` | gitea.io | +| `github` | github.com | +| `gitlab` | gitlab.com | +| `goodreads` | goodreads.com | +| `googlescholar` | scholar.google.com | +| `guruShots` | gurushots.com | +| `hackerone` | hackerone.com | +| `hackerrank` | hackerrank.com | +| `hackthebox` | hackthebox.eu | +| `instagram` | instagram.com | +| `itchio` | itch.io | +| `kaggle` | - | +| `kakaotalk` | kakaocorp.com/service/KakaoTalk | +| `key` | - | +| `keybase` | keybase.io | +| `kofi` | ko-fi.com | +| `komoot` | - | +| `lastfm` | last.fm | +| `letterboxd` | - | +| `liberapay` | liberapay.com | +| `linkedin` | linkedin.com | +| `mastodon` | mastodon.social | +| `matrix` | matrix.org | +| `medium` | medium.com | +| `monero` | - | +| `mixcloud` | mixcloud.com | +| `nuget` | nuget.org | +| `paypal` | paypal.com | +| `peertube` | - | +| `pgp` | - | +| `phone` | - | +| `ploywork` | ploywork.com | +| `qq` | qq.com | +| `reddit` | reddit.com | +| `researchgate` | researchgate.net | +| `rss` | - | +| `serverfault` | serverfault.com | +| `soundcloud` | soundcloud.com | +| `shutterstock` | shutterstock.com | +| `slack` | slack.com | +| `snapchat` | snapchat.com/add | +| `spotify` | spotify.com | +| `stackoverflow` | stackoverflow.com | +| `steam` | steampowered.com | +| `strava` | strava.com | +| `telegram` | telegram.org | +| `tiktok | tiktok.com | +| `twitch` | twitch.tv | +| `twitter` | twitter.com | +| `unsplash` | unsplash.com | +| `xda` | xda-developers.com | +| `xing` | xing.com | +| `ycombinator` | ycombinator.com | +| `youtube` | youtube.com | +| `other` | - | Usage : ``` socialIcons: - - name: "kofi" - url: "https://kofi.com" - - name: "twitter" - url: "https://twitter.com" + - name: "kofi" + url: "https://kofi.com" + - name: "twitter" + url: "https://twitter.com" ``` --- ## Share Icons -| No. | Platform | -| --- | --------------------------------------------------------------- | -| 1 | `twitter` (also generates hash tags from tags linked with post) | -| 2 | `linkedin` | -| 3 | `reddit` | -| 4 | `facebook` | -| 5 | `whatsapp` | -| 6 | `telegram` | +| No. | Platform | +| --------------------------------------------------------------- | -------- | +| `twitter` (also generates hash tags from tags linked with post) | +| `linkedin` | +| `reddit` | +| `facebook` | +| `whatsapp` | +| `telegram` | Usage: @@ -99,3 +119,8 @@ Usage: params: ShowShareButtons: true ``` + +```yml +params: + ShareButtons: ["linkedin", "twitter"] # To customize which share buttons to be enabled on page +``` diff --git a/content/posts/papermod/papermod-installation.md b/content/posts/papermod/papermod-installation.md index 68c3b834..01edea9f 100644 --- a/content/posts/papermod/papermod-installation.md +++ b/content/posts/papermod/papermod-installation.md @@ -11,8 +11,8 @@ author: "Aditya Telange" ## Intro -- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.** -- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary. +- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.** +- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary. --- @@ -47,10 +47,10 @@ git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth ### Method 2 -You can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with +you can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with ```bash -git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1 +git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically) ``` @@ -68,12 +68,13 @@ Or you can Download as Zip from Github Page and extract in your themes directory Direct Links: -- [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip) -- [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip) -- [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip) -- [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip) -- [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip) -- [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip) +- [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip) +- [v6.0](https://github.com/adityatelange/hugo-PaperMod/archive/v6.0.zip) +- [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip) +- [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip) +- [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip) +- [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip) +- [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip) ### Finally ... @@ -137,132 +138,135 @@ enableRobotsTXT: true buildDrafts: false buildFuture: false buildExpired: false -pygmentsUseClasses: true googleAnalytics: UA-123-45 minify: - disableXML: true - minifyOutput: true + disableXML: true + minifyOutput: true params: - env: production # to enable google analytics, opengraph, twitter-cards and schema. + env: production # to enable google analytics, opengraph, twitter-cards and schema. + title: ExampleSite + description: "ExampleSite description" + keywords: [Blog, Portfolio, PaperMod] + author: Me + # author: ["Me", "You"] # multiple authors + images: [""] + DateFormat: "January 2, 2006" + defaultTheme: auto # dark, light + disableThemeToggle: false + + ShowReadingTime: true + ShowShareButtons: true + ShowPostNavLinks: true + ShowBreadCrumbs: true + ShowCodeCopyButtons: false + ShowWordCount: true + ShowRssButtonInSectionTermList: true + UseHugoToc: true + disableSpecial1stPost: false + disableScrollToTop: false + comments: false + hidemeta: false + hideSummary: false + showtoc: false + tocopen: false + + assets: + # disableHLJS: true # to disable highlight.js + # disableFingerprinting: true + favicon: "" + favicon16x16: "" + favicon32x32: "" + apple_touch_icon: "" + safari_pinned_tab: "" + + label: + text: "Home" + icon: /apple-touch-icon.png + iconHeight: 35 + + # profile-mode + profileMode: + enabled: false # needs to be explicitly set title: ExampleSite - description: "ExampleSite description" - keywords: [Blog, Portfolio, PaperMod] - author: Me - # author: ["Me", "You"] # multiple authors - images: [""] - DateFormat: "January 2, 2006" - defaultTheme: auto # dark, light - disableThemeToggle: false + subtitle: "This is subtitle" + imageUrl: "" + imageWidth: 120 + imageHeight: 120 + imageTitle: my image + buttons: + - name: Posts + url: posts + - name: Tags + url: tags - ShowReadingTime: true - ShowShareButtons: true - ShowPostNavLinks: true - ShowBreadCrumbs: true - ShowCodeCopyButtons: false - disableSpecial1stPost: false - disableScrollToTop: false - comments: false - hidemeta: false - hideSummary: false - showtoc: false - tocopen: false + # home-info mode + homeInfoParams: + Title: "Hi there \U0001F44B" + Content: Welcome to my blog - assets: - # disableHLJS: true # to disable highlight.js - # disableFingerprinting: true - favicon: "" - favicon16x16: "" - favicon32x32: "" - apple_touch_icon: "" - safari_pinned_tab: "" + socialIcons: + - name: twitter + url: "https://twitter.com/" + - name: stackoverflow + url: "https://stackoverflow.com" + - name: github + url: "https://github.com/" - label: - text: "Home" - icon: /apple-touch-icon.png - iconHeight: 35 + analytics: + google: + SiteVerificationTag: "XYZabc" + bing: + SiteVerificationTag: "XYZabc" + yandex: + SiteVerificationTag: "XYZabc" - # profile-mode - profileMode: - enabled: false # needs to be explicitly set - title: ExampleSite - subtitle: "This is subtitle" - imageUrl: "" - imageWidth: 120 - imageHeight: 120 - imageTitle: my image - buttons: - - name: Posts - url: posts - - name: Tags - url: tags + cover: + hidden: true # hide everywhere but not in structured data + hiddenInList: true # hide on list pages and home + hiddenInSingle: true # hide on single page - # home-info mode - homeInfoParams: - Title: "Hi there \U0001F44B" - Content: Welcome to my blog + editPost: + URL: "https://github.com//content" + Text: "Suggest Changes" # edit text + appendFilePath: true # to append file path to Edit link - socialIcons: - - name: twitter - url: "https://twitter.com/" - - name: stackoverflow - url: "https://stackoverflow.com" - - name: github - url: "https://github.com/" - - analytics: - google: - SiteVerificationTag: "XYZabc" - bing: - SiteVerificationTag: "XYZabc" - yandex: - SiteVerificationTag: "XYZabc" - - cover: - hidden: true # hide everywhere but not in structured data - hiddenInList: true # hide on list pages and home - hiddenInSingle: true # hide on single page - - editPost: - URL: "https://github.com//content" - Text: "Suggest Changes" # edit text - appendFilePath: true # to append file path to Edit link - - # for search - # https://fusejs.io/api/options.html - fuseOpts: - isCaseSensitive: false - shouldSort: true - location: 0 - distance: 1000 - threshold: 0.4 - minMatchCharLength: 0 - keys: ["title", "permalink", "summary", "content"] + # for search + # https://fusejs.io/api/options.html + fuseOpts: + isCaseSensitive: false + shouldSort: true + location: 0 + distance: 1000 + threshold: 0.4 + minMatchCharLength: 0 + keys: ["title", "permalink", "summary", "content"] menu: - main: - - identifier: categories - name: categories - url: /categories/ - weight: 10 - - identifier: tags - name: tags - url: /tags/ - weight: 20 - - identifier: example - name: example.org - url: https://example.org - weight: 30 + main: + - identifier: categories + name: categories + url: /categories/ + weight: 10 + - identifier: tags + name: tags + url: /tags/ + weight: 20 + - identifier: example + name: example.org + url: https://example.org + weight: 30 # Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma -# pygmentsUseClasses: true -# markup: -# highlight: -# # anchorLineNos: true -# codeFences: true -# guessSyntax: true -# lineNos: true -# style: monokai +pygmentsUseClasses: true +markup: + highlight: + noClasses: false + # anchorLineNos: true + # codeFences: true + # guessSyntax: true + # lineNos: true + # style: monokai ``` --- @@ -293,7 +297,9 @@ searchHidden: true ShowReadingTime: true ShowBreadCrumbs: true ShowPostNavLinks: true +ShowWordCount: true ShowRssButtonInSectionTermList: true +UseHugoToc: true cover: image: "" # image path/url alt: "" # alt text diff --git a/content/posts/papermod/papermod-variables.md b/content/posts/papermod/papermod-variables.md index 27c913ba..29f09113 100644 --- a/content/posts/papermod/papermod-variables.md +++ b/content/posts/papermod/papermod-variables.md @@ -14,44 +14,49 @@ weight: 5 ### Site Variables under `Params` -| name | type | example | Description | -| -------------------------------------- | ------------- | ------------------------ | ----------------------------------------------------------------------------------------- | -| `env` | string | 'production' | To set env to production | -| `title` | string | 'My Blog' | To set title | -| `description` | string | 'This is a blog of mine' | To set site description | -| `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | -| `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards | -| `keywords` | list | [blog, page] | Add keywords for Home page | -| `DateFormat` | string | "January 2, 2006" | The format of date strings in the website. [Details](https://gohugo.io/functions/format/) | -| `languageAltTitle` | string | "English" | Alternate title in Multilingual Mode | -| `ShowReadingTime` | boolean | true \| false | To show read time in post meta | -| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post | -| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button | -| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show/hide RSS Copy button in Section and Term list | -| `ShowFullTextinRSS` | boolean | true \| false | To show Content in RSS feed | -| `defaultTheme` | string | light \| dark \| auto | To set default theme | -| `disableThemeToggle` | boolean | true \| false | To disable theme toggle icon shown besides label | -| `disableSpecial1stPost` | boolean | true \| false | To disable no-card special appearance of 1st post | -| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button | -| `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings | -| `hideMeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page | -| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | -| `showtoc` | boolean | true \| false | To show/hide Table of Contents | -| `tocopen` | boolean | true \| false | To keep open ToC by default on page load | -| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post | -| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page | -| `comments` | boolean | true \| false | To show/hide comments | -| `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics | -| `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing | -| `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex | -| `schema` | - | - | [Details](#schema) | -| `fuseOpts` | - | - | [Details](#fuseOpts) | -| `socialIcons` | - | - | [Details](#socialIcons) | -| `label` | - | - | [Details](#label) | -| `assets` | - | - | [Details](#assets) | -| `cover` | - | - | [Details](#cover) | -| `profileMode` | - | - | [Details](#profilemode) | -| `editPost` | - | - | [Details](#editPost) | +| name | type | example | Description | +| -------------------------------------- | ------------- | ------------------------- | ----------------------------------------------------------------------------------------- | +| `env` | string | 'production' | To set env to production | +| `title` | string | 'My Blog' | To set title | +| `description` | string | 'This is a blog of mine' | To set site description | +| `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | +| `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards | +| `keywords` | list | [blog, page] | Add keywords for Home page | +| `DateFormat` | string | "January 2, 2006" | The format of date strings in the website. [Details](https://gohugo.io/functions/format/) | +| `languageAltTitle` | string | "English" | Alternate title in Multilingual Mode | +| `ShowReadingTime` | boolean | true \| false | To show read time in post meta | +| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post | +| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button | +| `ShowFullTextinRSS` | boolean | true \| false | To show Content in RSS feed | +| `defaultTheme` | string | light \| dark \| auto | To set default theme | +| `disableThemeToggle` | boolean | true \| false | To disable theme toggle icon shown besides label | +| `disableSpecial1stPost` | boolean | true \| false | To disable no-card special appearance of 1st post | +| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button | +| `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings | +| `hideMeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page | +| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | +| `showtoc` | boolean | true \| false | To show/hide Table of Contents | +| `tocopen` | boolean | true \| false | To keep open ToC by default on page load | +| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post | +| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page | +| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page | +| `ShowWordCount` | boolean | true \| false | To word count to metadata | +| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show RSS icon in Section, Term and List pages | +| `UseHugoToc` | boolean | true \| false | To use Hugo's default Toc instead of custom | +| `comments` | boolean | true \| false | To show/hide comments | +| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page | +| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname | +| `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics | +| `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing | +| `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex | +| `schema` | - | - | [Details](#schema) | +| `fuseOpts` | - | - | [Details](#fuseOpts) | +| `socialIcons` | - | - | [Details](#socialIcons) | +| `label` | - | - | [Details](#label) | +| `assets` | - | - | [Details](#assets) | +| `cover` | - | - | [Details](#cover) | +| `profileMode` | - | - | [Details](#profilemode) | +| `editPost` | - | - | [Details](#editPost) | ### Site Variables @@ -93,11 +98,13 @@ profileMode: #### assets -| name | type | example | Description | -| ------------------------------ | ------- | ------------- | -------------------------------------------- | -| `assets.favicon` | string | 'icon.ico' | To set favicon, can be path or external link | -| `assets.disableHLJS` | boolean | true \| false | To disable Highlight.js loading | -| `assets.disableFingerprinting` | boolean | true \| false | To disable Sub-Resource integrity for assets | +| name | type | example | Description | +| -------------------------------- | ------- | ------------- | -------------------------------------------- | +| `assets.favicon` | string | 'icon.ico' | To set favicon, can be path or external link | +| `assets.disableHLJS` | boolean | true \| false | To disable Highlight.js loading | +| `assets.disableFingerprinting` | boolean | true \| false | To disable Sub-Resource integrity for assets | +| `assets.theme_color` | string | '#color' | To set custom meta theme-color | +| `assets.msapplication_TileColor` | string | '#color' | To set custom msapplication_TileColor | #### cover @@ -164,19 +171,28 @@ editPost: | `comments` | boolean | true \| false | To show/hide comments | | `description` | string | 'description text' | Show Post Description under Title | | `canonicalURL` | string | "https://canonical.url/to/page" | To add canonical URL to posts | +| `ShowCanonicalLink` | boolean | true \| false | To show canonical URL's hostname | +| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname | | `disableShare` | boolean | true \| false | To hide/show share icons under a page | | `disableHLJS` | boolean | true \| false | To disable Highlight.js loading | | `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings | | `searchHidden` | boolean | true \| false | Hide page from search | | `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | +| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page | | `ShowReadingTime` | boolean | true \| false | To show read time in post meta | | `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page | | `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post | -| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show/hide RSS Copy button in Section and Term list | +| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button | | `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | | `cover.image` | string | 'featured.jpg' | To add a cover image | | `cover.caption ` | string | 'caption for image' | To add caption to cover image | | `cover.alt` | string | 'this is cover image' | Alternate text to show if image doesn't load/show up | | `cover.relative` | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles | -| `cover.hidden ` | boolean | true \| false | To hide on current single page | +| `cover.responsiveImages` | boolean | true \| false | To enable/disable generation of responsive cover images | +| `cover.hidden` | boolean | true \| false | To hide on current single page | | `weight ` | integer | 5 | To set page order or to pin a post to Top of list | +| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page | +| `ShowWordCount` | boolean | true \| false | To word count to metadata | +| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show RSS icon in Section, Term and List pages | +| `UseHugoToc` | boolean | true \| false | To use Hugo's default Toc instead of custom | +| `robotsNoIndex` | boolean | true \| false | To hide a particular page from indexing by search engines |