mirrors/hugo-PaperMod
1
0
Fork 0
mirror of https://github.com/adityatelange/hugo-PaperMod.git synced 2025-11-03 18:02:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs from wiki

Browse Source 
0c64647
This commit is contained in:
Aditya Telange
2021-05-01 22:00:28 +05:30
parent 79d978aa74
commit 0593160cbd
2 changed files with 28 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/posts/papermod/papermod-installation.md
View File

@@ -36,7 +36,7 @@ Inside the folder of your Hugo site, run:
git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1 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 : > Updating theme :
> >
@@ -138,6 +138,7 @@ params:
ShowShareButtons: true ShowShareButtons: true
ShowPostNavLinks: true ShowPostNavLinks: true
ShowBreadCrumbs: true ShowBreadCrumbs: true
ShowCodeCopyButtons: false
disableSpecial1stPost: false disableSpecial1stPost: false
disableScrollToTop: false disableScrollToTop: false
comments: false comments: false
@@ -260,6 +261,7 @@ draft: false
hidemeta: false hidemeta: false
comments: false comments: false
description: "Desc Text." description: "Desc Text."
canonicalURL: "https://canonical.url/to/page"
disableHLJS: true # to disable highlightjs disableHLJS: true # to disable highlightjs
disableShare: false disableShare: false
disableHLJS: false disableHLJS: false

46
content/posts/papermod/papermod-variables.md
View File

@@ -23,8 +23,11 @@ weight: 5
| `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards | | `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards |
| `keywords` | list | [blog, page] | Add keywords for Home page | | `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/) | | `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 | | `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post | | `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 | | `defaultTheme` | string | light \| dark \| auto | To set default theme |
| `disableThemeToggle` | boolean | true \| false | To disable theme toggle icon shown besides label | | `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 | | `disableSpecial1stPost` | boolean | true \| false | To disable no-card special appearance of 1st post |
@@ -137,24 +140,25 @@ editPost:
### Page Variables ### Page Variables
| Name | Type | Example | Description | | Name | Type | Example | Description |
| ------------------ | ------------- | --------------------- | ----------------------------------------------------------------------------------- | | ------------------ | ------------- | ------------------------------- | ----------------------------------------------------------------------------------- |
| `showtoc` | boolean | true \| false | To show/hide Table of Contents | | `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| `tocopen` | boolean | true \| false | To keep open ToC by default on page load | | `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 | | `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 | | `comments` | boolean | true \| false | To show/hide comments |
| `description` | string | 'description text' | Show Post Description under Title | | `description` | string | 'description text' | Show Post Description under Title |
| `disableShare` | boolean | true \| false | To hide/show share icons under a page | | `canonicalURL` | string | "https://canonical.url/to/page" | To add canonical URL to posts |
| `disableHLJS` | boolean | true \| false | To disable Highlight.js loading | | `disableShare` | boolean | true \| false | To hide/show share icons under a page |
| `searchHidden` | boolean | true \| false | Hide page from search | | `disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | | `searchHidden` | boolean | true \| false | Hide page from search |
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta | | `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page | | `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post | | `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | | `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| `cover.image` | string | 'featured.jpg' | To add a cover image | | `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| `cover.caption ` | string | 'caption for image' | To add caption to cover image | | `cover.image` | string | 'featured.jpg' | To add a cover image |
| `cover.alt` | string | 'this is cover image' | Alternate text to show if image doesn't load/show up | | `cover.caption ` | string | 'caption for image' | To add caption to cover image |
| `cover.relative` | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles | | `cover.alt` | string | 'this is cover image' | Alternate text to show if image doesn't load/show up |
| `cover.hidden ` | boolean | true \| false | To hide on current single page | | `cover.relative` | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles |
| `weight ` | integer | 5 | To set page order or to pin a post to Top of list | | `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 |