From e42bf3aaa58eb117f081dc0bea8c4e3efa2663dc Mon Sep 17 00:00:00 2001 From: Aditya Telange <21258296+adityatelange@users.noreply.github.com> Date: Sat, 1 May 2021 21:46:55 +0530 Subject: [PATCH] Update docs upto 0c64647 --- Translations.md | 1 + Variables.md | 44 +++++++++++++++++++++++--------------------- 2 files changed, 24 insertions(+), 21 deletions(-) diff --git a/Translations.md b/Translations.md index e14a740..e8a4744 100644 --- a/Translations.md +++ b/Translations.md @@ -19,6 +19,7 @@ | Japanese | ja | prev_page, next_page, read_time, toc, translations | | Korean | ko | prev_page, next_page | | 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 | | 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 | diff --git a/Variables.md b/Variables.md index b75d444..b4aa6fa 100644 --- a/Variables.md +++ b/Variables.md @@ -20,6 +20,7 @@ | `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 | @@ -132,24 +133,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 |