From 0593160cbd4d8d1a86079167d3e06d20fa3a7c05 Mon Sep 17 00:00:00 2001 From: Aditya Telange <21258296+adityatelange@users.noreply.github.com> Date: Sat, 1 May 2021 22:00:28 +0530 Subject: [PATCH] Update docs from wiki 0c64647 --- .../posts/papermod/papermod-installation.md | 4 +- content/posts/papermod/papermod-variables.md | 46 ++++++++++--------- 2 files changed, 28 insertions(+), 22 deletions(-) diff --git a/content/posts/papermod/papermod-installation.md b/content/posts/papermod/papermod-installation.md index 8c09ed23..42bd8c78 100644 --- a/content/posts/papermod/papermod-installation.md +++ b/content/posts/papermod/papermod-installation.md @@ -36,7 +36,7 @@ Inside the folder of your Hugo site, run: git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1 ``` -**Note**: You may use ` --branch v3.0` to end of above command if you want to stick to specific release. +**Note**: You may use ` --branch v5.0` to end of above command if you want to stick to specific release. > Updating theme : > @@ -138,6 +138,7 @@ params: ShowShareButtons: true ShowPostNavLinks: true ShowBreadCrumbs: true + ShowCodeCopyButtons: false disableSpecial1stPost: false disableScrollToTop: false comments: false @@ -260,6 +261,7 @@ draft: false hidemeta: false comments: false description: "Desc Text." +canonicalURL: "https://canonical.url/to/page" disableHLJS: true # to disable highlightjs disableShare: false disableHLJS: false diff --git a/content/posts/papermod/papermod-variables.md b/content/posts/papermod/papermod-variables.md index 93aa1c37..e575624e 100644 --- a/content/posts/papermod/papermod-variables.md +++ b/content/posts/papermod/papermod-variables.md @@ -23,8 +23,11 @@ weight: 5 | `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 | @@ -137,24 +140,25 @@ editPost: ### Page Variables -| Name | Type | Example | Description | -| ------------------ | ------------- | --------------------- | ----------------------------------------------------------------------------------- | -| `showtoc` | boolean | true \| false | To show/hide Table of Contents | -| `tocopen` | boolean | true \| false | To keep open ToC by default on page load | -| `hidemeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page | -| `comments` | boolean | true \| false | To show/hide comments | -| `description` | string | 'description text' | Show Post Description under Title | -| `disableShare` | boolean | true \| false | To hide/show share icons under a page | -| `disableHLJS` | boolean | true \| false | To disable Highlight.js loading | -| `searchHidden` | boolean | true \| false | Hide page from search | -| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | -| `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 | -| `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 | -| `weight ` | integer | 5 | To set page order or to pin a post to Top of list | +| Name | Type | Example | Description | +| ------------------ | ------------- | ------------------------------- | ----------------------------------------------------------------------------------- | +| `showtoc` | boolean | true \| false | To show/hide Table of Contents | +| `tocopen` | boolean | true \| false | To keep open ToC by default on page load | +| `hidemeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page | +| `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 | +| `disableShare` | boolean | true \| false | To hide/show share icons under a page | +| `disableHLJS` | boolean | true \| false | To disable Highlight.js loading | +| `searchHidden` | boolean | true \| false | Hide page from search | +| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | +| `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 | +| `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 | +| `weight ` | integer | 5 | To set page order or to pin a post to Top of list |