From 225acda2cd2bc4c13a6abd52b2a1b45bdea71527 Mon Sep 17 00:00:00 2001 From: Aditya Telange <21258296+adityatelange@users.noreply.github.com> Date: Sat, 14 Aug 2021 20:10:00 +0530 Subject: [PATCH] Update docs upto 7d67d64 --- content/posts/papermod/papermod-icons.md | 79 +++++++++++--------- content/posts/papermod/papermod-variables.md | 72 ++++++++++-------- 2 files changed, 83 insertions(+), 68 deletions(-) diff --git a/content/posts/papermod/papermod-icons.md b/content/posts/papermod/papermod-icons.md index f6e5c990..d9bf636d 100644 --- a/content/posts/papermod/papermod-icons.md +++ b/content/posts/papermod/papermod-icons.md @@ -27,41 +27,48 @@ draft: true | 12 | `dribbble` | dribbble.com | | 13 | `email` | - | | 14 | `facebook` | facebook.com | -| 15 | `freepik` | freepik.com | -| 16 | `gitea` | gitea.io | -| 17 | `github` | github.com | -| 18 | `gitlab` | gitlab.com | -| 19 | `hackerone` | hackerone.com | -| 20 | `hackerrank` | hackerrank.com | -| 21 | `hackthebox` | hackthebox.eu | -| 22 | `instagram` | instagram.com | -| 23 | `itchio` | itch.io | -| 24 | `kakaotalk` | kakaocorp.com/service/KakaoTalk | -| 25 | `keybase` | keybase.io | -| 26 | `kofi` | ko-fi.com | -| 27 | `lastfm` | last.fm | -| 28 | `linkedin` | linkedin.com | -| 29 | `mastodon` | mastodon.social | -| 30 | `medium` | medium.com | -| 31 | `mixcloud` | mixcloud.com | -| 32 | `nuget` | nuget.org | -| 33 | `paypal` | paypal.com | -| 34 | `qq` | qq.com | -| 35 | `reddit` | reddit.com | -| 36 | `rss` | - | -| 37 | `soundcloud` | soundcloud.com | -| 38 | `shutterstock` | shutterstock.com | -| 39 | `slack` | slack.com | -| 40 | `snapchat` | snapchat.com/add | -| 41 | `sourcerer` | sourcerer.io | -| 42 | `stackoverflow` | stackoverflow.com | -| 43 | `steam` | steampowered.com | -| 44 | `telegram` | telegram.org | -| 45 | `twitch` | twitch.tv | -| 46 | `twitter` | twitter.com | -| 47 | `unsplash` | unsplash.com | -| 48 | `youtube` | youtube.com | -| 49 | `other` | - | +| 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` | - | Usage : @@ -90,5 +97,5 @@ Usage: ```yml params: - ShowShareButtons: true + ShowShareButtons: true ``` diff --git a/content/posts/papermod/papermod-variables.md b/content/posts/papermod/papermod-variables.md index 30b46ba9..aa8eb60c 100644 --- a/content/posts/papermod/papermod-variables.md +++ b/content/posts/papermod/papermod-variables.md @@ -32,6 +32,7 @@ weight: 5 | `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 | @@ -51,6 +52,12 @@ weight: 5 | `profileMode` | - | - | [Details](#profilemode) | | `editPost` | - | - | [Details](#editPost) | +### Site Variables + +| name | type | example | Description | +| ----------- | ------ | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | +| `copyright` | string | `**[example.site](https://example.site)**` | This is [HUGO's site variable](https://gohugo.io/variables/site/#site-variables-list), which can also render markdown content | + #### label | name | type | example | Description | @@ -114,13 +121,13 @@ Refer: https://fusejs.io/api/options.html ```yml fuseOpts: - isCaseSensitive: false - shouldSort: true - location: 0 - distance: 1000 - threshold: 0.4 - minMatchCharLength: 0 - keys: ["title", "permalink", "summary", "content"] ## can be less but not more than shown in list + isCaseSensitive: false + shouldSort: true + location: 0 + distance: 1000 + threshold: 0.4 + minMatchCharLength: 0 + keys: ["title", "permalink", "summary", "content"] ## can be less but not more than shown in list ``` #### socialIcons @@ -137,9 +144,9 @@ socialIcons: ```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 ``` > Note: Same format is being used by Page Variables @@ -148,25 +155,26 @@ 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 | -| `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 | +| 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 | +| `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 | +| `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 |