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 7d67d64

Aditya Telange 2021-08-14 20:07:18 +05:30
parent 9cadee768e
commit dc7e15425e
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
3 changed files with 82 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
Icons.md

@ -21,41 +21,48 @@
| 12 | `dribbble` | dribbble.com | | 12 | `dribbble` | dribbble.com |
| 13 | `email` | - | | 13 | `email` | - |
| 14 | `facebook` | facebook.com | | 14 | `facebook` | facebook.com |
| 15 | `freepik` | freepik.com | | 15 | `flickr` | flickr.com |
| 16 | `gitea` | gitea.io | | 16 | `freepik` | freepik.com |
| 17 | `github` | github.com | | 17 | `gitea` | gitea.io |
| 18 | `gitlab` | gitlab.com | | 18 | `github` | github.com |
| 19 | `hackerone` | hackerone.com | | 19 | `gitlab` | gitlab.com |
| 20 | `hackerrank` | hackerrank.com | | 20 | `goodreads` | goodreads.com |
| 21 | `hackthebox` | hackthebox.eu | | 21 | `hackerone` | hackerone.com |
| 22 | `instagram` | instagram.com | | 22 | `hackerrank` | hackerrank.com |
| 23 | `itchio` | itch.io | | 23 | `hackthebox` | hackthebox.eu |
| 24 | `kakaotalk` | kakaocorp.com/service/KakaoTalk | | 24 | `instagram` | instagram.com |
| 25 | `keybase` | keybase.io | | 25 | `itchio` | itch.io |
| 26 | `kofi` | ko-fi.com | | 26 | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 27 | `lastfm` | last.fm | | 27 | `keybase` | keybase.io |
| 28 | `linkedin` | linkedin.com | | 28 | `kofi` | ko-fi.com |
| 29 | `mastodon` | mastodon.social | | 29 | `lastfm` | last.fm |
| 30 | `medium` | medium.com | | 30 | `liberapay` | liberapay.com |
| 31 | `mixcloud` | mixcloud.com | | 31 | `linkedin` | linkedin.com |
| 32 | `nuget` | nuget.org | | 32 | `mastodon` | mastodon.social |
| 33 | `paypal` | paypal.com | | 33 | `matrix` | matrix.org |
| 34 | `qq` | qq.com | | 34 | `medium` | medium.com |
| 35 | `reddit` | reddit.com | | 35 | `mixcloud` | mixcloud.com |
| 36 | `rss` | - | | 36 | `nuget` | nuget.org |
| 37 | `soundcloud` | soundcloud.com | | 37 | `paypal` | paypal.com |
| 38 | `shutterstock` | shutterstock.com | | 38 | `qq` | qq.com |
| 39 | `slack` | slack.com | | 39 | `reddit` | reddit.com |
| 40 | `snapchat` | snapchat.com/add | | 40 | `rss` | - |
| 41 | `sourcerer` | sourcerer.io | | 41 | `serverfault` | serverfault.com |
| 42 | `stackoverflow` | stackoverflow.com | | 42 | `soundcloud` | soundcloud.com |
| 43 | `steam` | steampowered.com | | 43 | `shutterstock` | shutterstock.com |
| 44 | `telegram` | telegram.org | | 44 | `slack` | slack.com |
| 45 | `twitch` | twitch.tv | | 45 | `snapchat` | snapchat.com/add |
| 46 | `twitter` | twitter.com | | 46 | `sourcerer` | sourcerer.io |
| 47 | `unsplash` | unsplash.com | | 47 | `spotify` | spotify.com |
| 48 | `youtube` | youtube.com | | 48 | `stackoverflow` | stackoverflow.com |
| 49 | `other` | - | | 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 : Usage :
@ -84,5 +91,5 @@ Usage:
```yml ```yml
params: params:
ShowShareButtons: true ShowShareButtons: true
``` ```

8
Translations.md

@ -4,6 +4,7 @@
| ---------- | -------- | ------------------------------------------------------------------------------------------- | | ---------- | -------- | ------------------------------------------------------------------------------------------- |
| Arabic | ar | prev_page, next_page, read_time, toc, translations, home | | Arabic | ar | prev_page, next_page, read_time, toc, translations, home |
| Bulgarian | bg | prev_page, next_page, read_time, toc, translations | | Bulgarian | bg | prev_page, next_page, read_time, toc, translations |
| Bengali | bn | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Catalan | ca | prev_page, next_page, read_time, toc, translations, home | | Catalan | ca | prev_page, next_page, read_time, toc, translations, home |
| German | de | prev_page, next_page, read_time, toc, translations, edit_post | | German | de | prev_page, next_page, read_time, toc, translations, edit_post |
| English | en | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied | | English | en | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
@ -19,6 +20,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 |
| Dutch | nl | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Polish | pl | prev_page, next_page, read_time, toc, translations, home, edit_post, 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 |
@ -26,7 +28,7 @@
| Ukrainian | uk | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied | | Ukrainian | uk | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Uzbek | uz | prev_page, next_page, read_time, toc, translations, home | | Uzbek | uz | prev_page, next_page, read_time, toc, translations, home |
| Vietnamese | vi | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied | | Vietnamese | vi | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Chinese | zh | prev_page, next_page, read_time, toc, translations | | Chinese | zh | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
## Want to add your Language ? ## Want to add your Language ?
@ -45,8 +47,8 @@ ISO codes can be found here: https://www.w3schools.com/tags/ref_language_codes.a
- id: read_time - id: read_time
translation: translation:
one: "1 min" one: "1 min"
other: "{{ .Count }} min" other: "{{ .Count }} min"
- id: toc - id: toc
translation: "Table of Contents" translation: "Table of Contents"

66
Variables.md

@ -25,6 +25,7 @@
| `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 |
| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button | | `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 | | `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 | | `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages |
| `showtoc` | boolean | true \| false | To show/hide Table of Contents | | `showtoc` | boolean | true \| false | To show/hide Table of Contents |
@ -113,13 +114,13 @@ Refer: https://fusejs.io/api/options.html
```yml ```yml
fuseOpts: fuseOpts:
isCaseSensitive: false isCaseSensitive: false
shouldSort: true shouldSort: true
location: 0 location: 0
distance: 1000 distance: 1000
threshold: 0.4 threshold: 0.4
minMatchCharLength: 0 minMatchCharLength: 0
keys: ["title", "permalink", "summary", "content"] ## can be less but not more than shown in list keys: ["title", "permalink", "summary", "content"] ## can be less but not more than shown in list
``` ```
#### socialIcons #### socialIcons
@ -136,9 +137,9 @@ socialIcons:
```yml ```yml
editPost: editPost:
URL: "https://github.com/<path_to_repo>/content" URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link appendFilePath: true # to append file path to Edit link
``` ```
> Note: Same format is being used by Page Variables > Note: Same format is being used by Page Variables
@ -147,25 +148,26 @@ 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 |
| `canonicalURL` | string | "https://canonical.url/to/page" | To add canonical URL to posts | | `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 | | `disableShare` | boolean | true \| false | To hide/show share icons under a page |
| `disableHLJS` | boolean | true \| false | To disable Highlight.js loading | | `disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| `searchHidden` | boolean | true \| false | Hide page from search | | `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings |
| `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 |