mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2023-12-21 10:22:58 +01:00
Update docs upto cb9be55
Aditya Telange
parent
0e19e3276f
commit
803b1040c0
27
Icons.md
27
Icons.md
@ -9,12 +9,16 @@
|
||||
| --------------- | ------------------------------- |
|
||||
| `123rf` | 123rf.com |
|
||||
| `adobestock` | stock.adobe.com |
|
||||
| `apple music` | music.apple.com |
|
||||
| `behance` | behance.net |
|
||||
| `bilibili` | bilibili.com |
|
||||
| `bitcoin` | - |
|
||||
| `buymeacoffee` | buymeacoffee.com |
|
||||
| `codepen` | codepen.io |
|
||||
| `cryptohack` | cryptohack.org |
|
||||
| `ctftime` | ctftime.org |
|
||||
| `cv` | - |
|
||||
| `deezer` | deezer.com |
|
||||
| `dev` | dev.to |
|
||||
| `discogs` | discogs.com |
|
||||
| `discord` | discord.com |
|
||||
@ -29,23 +33,31 @@
|
||||
| `gitlab` | gitlab.com |
|
||||
| `goodreads` | goodreads.com |
|
||||
| `googlescholar` | scholar.google.com |
|
||||
| `guruShots` | gurushots.com |
|
||||
| `hackerone` | hackerone.com |
|
||||
| `hackerrank` | hackerrank.com |
|
||||
| `hackthebox` | hackthebox.eu |
|
||||
| `instagram` | instagram.com |
|
||||
| `itchio` | itch.io |
|
||||
| `kaggle` | - |
|
||||
| `kakaotalk` | kakaocorp.com/service/KakaoTalk |
|
||||
| `key` | - |
|
||||
| `keybase` | keybase.io |
|
||||
| `kofi` | ko-fi.com |
|
||||
| `komoot` | - |
|
||||
| `lastfm` | last.fm |
|
||||
| `letterboxd` | - |
|
||||
| `liberapay` | liberapay.com |
|
||||
| `linkedin` | linkedin.com |
|
||||
| `mastodon` | mastodon.social |
|
||||
| `matrix` | matrix.org |
|
||||
| `medium` | medium.com |
|
||||
| `monero` | - |
|
||||
| `mixcloud` | mixcloud.com |
|
||||
| `nuget` | nuget.org |
|
||||
| `paypal` | paypal.com |
|
||||
| `peertube` | - |
|
||||
| `pgp` | - |
|
||||
| `phone` | - |
|
||||
| `ploywork` | ploywork.com |
|
||||
| `qq` | qq.com |
|
||||
@ -60,7 +72,9 @@
|
||||
| `spotify` | spotify.com |
|
||||
| `stackoverflow` | stackoverflow.com |
|
||||
| `steam` | steampowered.com |
|
||||
| `strava` | strava.com |
|
||||
| `telegram` | telegram.org |
|
||||
| `tiktok | tiktok.com |
|
||||
| `twitch` | twitch.tv |
|
||||
| `twitter` | twitter.com |
|
||||
| `unsplash` | unsplash.com |
|
||||
@ -74,10 +88,10 @@ Usage :
|
||||
|
||||
```
|
||||
socialIcons:
|
||||
- name: "kofi"
|
||||
url: "https://kofi.com"
|
||||
- name: "twitter"
|
||||
url: "https://twitter.com"
|
||||
- name: "kofi"
|
||||
url: "https://kofi.com"
|
||||
- name: "twitter"
|
||||
url: "https://twitter.com"
|
||||
```
|
||||
|
||||
---
|
||||
@ -99,3 +113,8 @@ Usage:
|
||||
params:
|
||||
ShowShareButtons: true
|
||||
```
|
||||
|
||||
```yml
|
||||
params:
|
||||
ShareButtons: ["linkedin", "twitter"] # To customize which share buttons to be enabled on page
|
||||
```
|
||||
|
||||
@ -143,6 +143,9 @@ params:
|
||||
ShowPostNavLinks: true
|
||||
ShowBreadCrumbs: true
|
||||
ShowCodeCopyButtons: false
|
||||
ShowWordCount: true
|
||||
ShowRssButtonInSectionTermList: true
|
||||
UseHugoToc: true
|
||||
disableSpecial1stPost: false
|
||||
disableScrollToTop: false
|
||||
comments: false
|
||||
@ -274,6 +277,9 @@ searchHidden: true
|
||||
ShowReadingTime: true
|
||||
ShowBreadCrumbs: true
|
||||
ShowPostNavLinks: true
|
||||
ShowWordCount: true
|
||||
ShowRssButtonInSectionTermList: true
|
||||
UseHugoToc: true
|
||||
cover:
|
||||
image: "<image path/url>" # image path/url
|
||||
alt: "<alt text>" # alt text
|
||||
|
||||
@ -1,38 +1,40 @@
|
||||
## Languages Supported
|
||||
|
||||
| Name | ISO Code | Available Translations |
|
||||
| ---------------------------- | -------- | ------------------------------------------------------------------------------------------- |
|
||||
| Arabic | ar | prev_page, next_page, read_time, toc, translations, home |
|
||||
| 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 |
|
||||
| Northern and Central Kurdish | ckb | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Danish | da | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| 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 |
|
||||
| Esperanto | eo | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Spanish | es | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Farsi | fa | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| French | fr | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Hebrew | he | prev_page, next_page, read_time, toc, translations, home |
|
||||
| Hindi | hi | prev_page, next_page, read_time, toc, translations |
|
||||
| Hungarian | hu | prev_page, next_page, read_time, toc, translations |
|
||||
| Indonesian | id | prev_page, next_page, read_time, toc, translations |
|
||||
| Italian | it | prev_page, next_page, read_time, toc, translations |
|
||||
| Japanese | ja | prev_page, next_page, read_time, toc, translations, code_copy, code_copied |
|
||||
| Korean | ko | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Kurdish | ku | 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 |
|
||||
| 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 |
|
||||
| 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 |
|
||||
| Vietnamese | vi | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Taiwanese Chinese | zh-tw | rev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Chinese | zh | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Name | ISO Code | Available Translations |
|
||||
| ---------------------------- | -------- | -------------------------------------------------------------------------------------------------- |
|
||||
| Arabic | ar | prev_page, next_page, read_time, toc, translations, home |
|
||||
| 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 |
|
||||
| Northern and Central Kurdish | ckb | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Danish | da | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| German | de | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| English | en | prev_page, next_page, read_time, words, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| Esperanto | eo | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Spanish | es | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| Farsi | fa | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| French | fr | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Hebrew | he | prev_page, next_page, read_time, toc, translations, home |
|
||||
| Hindi | hi | prev_page, next_page, read_time, toc, translations |
|
||||
| Hungarian | hu | prev_page, next_page, read_time, toc, translations |
|
||||
| Indonesian | id | prev_page, next_page, read_time, toc, translations |
|
||||
| Italian | it | prev_page, next_page, read_time, toc, translations |
|
||||
| Japanese | ja | prev_page, next_page, read_time, toc, translations, code_copy, code_copied |
|
||||
| Korean | ko | prev_page, next_page, read_time, words, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| Kurdish | ku | 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 |
|
||||
| Malay | ms | prev_page, next_page, read_time, toc, translations, home, edit_post, 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 |
|
||||
| Portuguese | pt | prev_page, next_page, read_time, toc, translations |
|
||||
| Russian | ru | prev_page, next_page, read_time, toc, translations |
|
||||
| Swedish | sv | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| Turkish | tr | 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 |
|
||||
| Vietnamese | vi | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
|
||||
| Taiwanese Chinese | zh-tw | prev_page, next_page, read_time, words, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
| Chinese | zh | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
|
||||
|
||||
## Want to add your Language ?
|
||||
|
||||
@ -44,16 +46,21 @@ ISO codes can be found here: https://www.w3schools.com/tags/ref_language_codes.a
|
||||
|
||||
```yml
|
||||
- id: prev_page
|
||||
translation: "Prev Page"
|
||||
translation: "Prev"
|
||||
|
||||
- id: next_page
|
||||
translation: "Next Page"
|
||||
translation: "Next"
|
||||
|
||||
- id: read_time
|
||||
translation:
|
||||
one: "1 min"
|
||||
other: "{{ .Count }} min"
|
||||
|
||||
- id: words
|
||||
translation:
|
||||
one: "word"
|
||||
other: "{{ .Count }} words"
|
||||
|
||||
- id: toc
|
||||
translation: "Table of Contents"
|
||||
|
||||
|
||||
64
Variables.md
64
Variables.md
@ -33,6 +33,9 @@
|
||||
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
|
||||
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
|
||||
| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page |
|
||||
| `ShowWordCount` | boolean | true \| false | To word count to metadata |
|
||||
| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show RSS icon in Section, Term and List pages |
|
||||
| `UseHugoToc` | boolean | true \| false | To use Hugo's default Toc instead of custom |
|
||||
| `comments` | boolean | true \| false | To show/hide comments |
|
||||
| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page |
|
||||
| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname |
|
||||
@ -153,32 +156,35 @@ 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 |
|
||||
| `ShowCanonicalLink` | boolean | true \| false | To show canonical URL's hostname |
|
||||
| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname |
|
||||
| `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 |
|
||||
| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page |
|
||||
| `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 |
|
||||
| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button |
|
||||
| `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.responsiveImages` | boolean | true \| false | To enable/disable generation of responsive cover images |
|
||||
| `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 |
|
||||
| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page |
|
||||
| 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 |
|
||||
| `ShowCanonicalLink` | boolean | true \| false | To show canonical URL's hostname |
|
||||
| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname |
|
||||
| `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 |
|
||||
| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page |
|
||||
| `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 |
|
||||
| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button |
|
||||
| `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.responsiveImages` | boolean | true \| false | To enable/disable generation of responsive cover images |
|
||||
| `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 |
|
||||
| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page |
|
||||
| `ShowWordCount` | boolean | true \| false | To word count to metadata |
|
||||
| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show RSS icon in Section, Term and List pages |
|
||||
| `UseHugoToc` | boolean | true \| false | To use Hugo's default Toc instead of custom |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user