mirrors/hugo-PaperMod
1
0
Fork 0
mirror of https://github.com/adityatelange/hugo-PaperMod.git synced 2023-12-21 10:22:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs upto 0c64647

Aditya Telange 2021-05-01 21:46:55 +05:30
parent 51fc030be1
commit e42bf3aaa5
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
2 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Translations.md

@ -19,6 +19,7 @@
| Japanese | ja | prev_page, next_page, read_time, toc, translations | | Japanese | ja | prev_page, next_page, read_time, toc, translations |
| Korean | ko | prev_page, next_page | | Korean | ko | prev_page, next_page |
| Mongolian | mn | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied | | Mongolian | mn | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Polish | pl | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Portuguese | pt | prev_page, next_page, read_time, toc, translations | | Portuguese | pt | prev_page, next_page, read_time, toc, translations |
| Russian | ru | prev_page, next_page, read_time, toc, translations | | Russian | ru | prev_page, next_page, read_time, toc, translations |
| Turkish | tr | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied | | Turkish | tr | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |

44
Variables.md

@ -20,6 +20,7 @@
| `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 | | `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 |
@ -132,24 +133,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 |