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 1033afc

Aditya Telange 2021-10-30 13:07:13 +05:30
parent 06a6720c54
commit c12676754c
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
8 changed files with 467 additions and 452 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
FAQs.md

@ -177,7 +177,6 @@ title: "My Important post"
date: 2020-09-15T11:30:03+00:00 date: 2020-09-15T11:30:03+00:00
weight: 1 weight: 1
--- ---
``` ```
```yml ```yml
@ -186,7 +185,6 @@ title: "My 2nd Important post"
date: 2020-09-15T11:30:03+00:00 date: 2020-09-15T11:30:03+00:00
weight: 2 weight: 2
--- ---
``` ```
--- ---

1
Features.md

@ -206,6 +206,7 @@ layout: "search" # is necessary
# url: "/archive" # url: "/archive"
# description: "Description for Search" # description: "Description for Search"
summary: "search" summary: "search"
placeholder: "placeholder text in search input box"
--- ---
``` ```

133
Icons.md

@ -5,64 +5,67 @@
## Social Icons ## Social Icons
| No. | Name | Platform Link | | Name | Platform Link |
| --- | --------------- | ------------------------------- | | --------------- | ------------------------------- |
| 1 | `123rf` | 123rf.com | | `123rf` | 123rf.com |
| 2 | `adobestock` | stock.adobe.com | | `adobestock` | stock.adobe.com |
| 3 | `behance` | behance.net | | `behance` | behance.net |
| 4 | `buymeacoffee` | buymeacoffee.com | | `buymeacoffee` | buymeacoffee.com |
| 5 | `codepen` | codepen.io | | `codepen` | codepen.io |
| 6 | `cryptohack` | cryptohack.org | | `cryptohack` | cryptohack.org |
| 7 | `ctftime` | ctftime.org | | `ctftime` | ctftime.org |
| 8 | `dev` | dev.to | | `dev` | dev.to |
| 9 | `discogs` | discogs.com | | `discogs` | discogs.com |
| 10 | `discord` | discord.com | | `discord` | discord.com |
| 11 | `dreamstime` | dreamstime.com | | `dreamstime` | dreamstime.com |
| 12 | `dribbble` | dribbble.com | | `dribbble` | dribbble.com |
| 13 | `email` | - | | `email` | - |
| 14 | `facebook` | facebook.com | | `facebook` | facebook.com |
| 15 | `flickr` | flickr.com | | `flickr` | flickr.com |
| 16 | `freepik` | freepik.com | | `freepik` | freepik.com |
| 17 | `gitea` | gitea.io | | `gitea` | gitea.io |
| 18 | `github` | github.com | | `github` | github.com |
| 19 | `gitlab` | gitlab.com | | `gitlab` | gitlab.com |
| 20 | `goodreads` | goodreads.com | | `goodreads` | goodreads.com |
| 21 | `hackerone` | hackerone.com | | `googlescholar` | scholar.google.com |
| 22 | `hackerrank` | hackerrank.com | | `hackerone` | hackerone.com |
| 23 | `hackthebox` | hackthebox.eu | | `hackerrank` | hackerrank.com |
| 24 | `instagram` | instagram.com | | `hackthebox` | hackthebox.eu |
| 25 | `itchio` | itch.io | | `instagram` | instagram.com |
| 26 | `kakaotalk` | kakaocorp.com/service/KakaoTalk | | `itchio` | itch.io |
| 27 | `keybase` | keybase.io | | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 28 | `kofi` | ko-fi.com | | `keybase` | keybase.io |
| 29 | `lastfm` | last.fm | | `kofi` | ko-fi.com |
| 30 | `liberapay` | liberapay.com | | `lastfm` | last.fm |
| 31 | `linkedin` | linkedin.com | | `liberapay` | liberapay.com |
| 32 | `mastodon` | mastodon.social | | `linkedin` | linkedin.com |
| 33 | `matrix` | matrix.org | | `mastodon` | mastodon.social |
| 34 | `medium` | medium.com | | `matrix` | matrix.org |
| 35 | `mixcloud` | mixcloud.com | | `medium` | medium.com |
| 36 | `nuget` | nuget.org | | `mixcloud` | mixcloud.com |
| 37 | `paypal` | paypal.com | | `nuget` | nuget.org |
| 38 | `qq` | qq.com | | `paypal` | paypal.com |
| 39 | `reddit` | reddit.com | | `qq` | qq.com |
| 40 | `rss` | - | | `reddit` | reddit.com |
| 41 | `serverfault` | serverfault.com | | `researchgate` | researchgate.net |
| 42 | `soundcloud` | soundcloud.com | | `rss` | - |
| 43 | `shutterstock` | shutterstock.com | | `serverfault` | serverfault.com |
| 44 | `slack` | slack.com | | `soundcloud` | soundcloud.com |
| 45 | `snapchat` | snapchat.com/add | | `shutterstock` | shutterstock.com |
| 46 | `sourcerer` | sourcerer.io | | `slack` | slack.com |
| 47 | `spotify` | spotify.com | | `snapchat` | snapchat.com/add |
| 48 | `stackoverflow` | stackoverflow.com | | `sourcerer` | sourcerer.io |
| 49 | `steam` | steampowered.com | | `spotify` | spotify.com |
| 50 | `telegram` | telegram.org | | `stackoverflow` | stackoverflow.com |
| 51 | `twitch` | twitch.tv | | `steam` | steampowered.com |
| 52 | `twitter` | twitter.com | | `telegram` | telegram.org |
| 53 | `unsplash` | unsplash.com | | `twitch` | twitch.tv |
| 54 | `xda` | xda-developers.com | | `twitter` | twitter.com |
| 55 | `youtube` | youtube.com | | `unsplash` | unsplash.com |
| 56 | `other` | - | | `xda` | xda-developers.com |
| `ycombinator` | ycombinator.com |
| `youtube` | youtube.com |
| `other` | - |
Usage : Usage :
@ -79,13 +82,13 @@ socialIcons:
## Share Icons ## Share Icons
| No. | Platform | | No. | Platform |
| --- | --------------------------------------------------------------- | | --------------------------------------------------------------- | -------- |
| 1 | `twitter` (also generates hash tags from tags linked with post) | | `twitter` (also generates hash tags from tags linked with post) |
| 2 | `linkedin` | | `linkedin` |
| 3 | `reddit` | | `reddit` |
| 4 | `facebook` | | `facebook` |
| 5 | `whatsapp` | | `whatsapp` |
| 6 | `telegram` | | `telegram` |
Usage: Usage:

10
Translations.md

@ -1,24 +1,27 @@
## Languages Supported ## Languages Supported
| Name | ISO Code | Available Translations | | Name | ISO Code | Available Translations |
| ---------- | -------- | ------------------------------------------------------------------------------------------- | | ---------------------------- | -------- | ------------------------------------------------------------------------------------------- |
| 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 | | 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 |
| 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 | | 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 |
| Esperanto | eo | prev_page, next_page, read_time, toc, translations, home, 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 | | Spanish | es | prev_page, next_page, read_time, toc, translations |
| Farsi | fa | prev_page, next_page, read_time, toc, translations | | Farsi | fa | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| French | fr | prev_page, next_page | | French | fr | prev_page, next_page |
| Hebrew | he | prev_page, next_page, read_time, toc, translations, home | | Hebrew | he | prev_page, next_page, read_time, toc, translations, home |
| Hindi | hi | prev_page, next_page, read_time, toc, translations | | Hindi | hi | prev_page, next_page, read_time, toc, translations |
| Hungarian | hu | 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 | | Indonesian | id | prev_page, next_page, read_time, toc, translations |
| Italian | it | 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 | | Japanese | ja | prev_page, next_page, read_time, toc, translations, code_copy, code_copied |
| Korean | ko | prev_page, next_page | | Korean | ko | prev_page, next_page |
| 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 | | 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 | | 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 |
@ -28,6 +31,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 |
| 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 | | 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 ?

11
Variables.md

@ -8,7 +8,7 @@
### Site Variables under `Params` ### Site Variables under `Params`
| name | type | example | Description | | name | type | example | Description |
| -------------------------------------- | ------------- | ------------------------ | ----------------------------------------------------------------------------------------- | | -------------------------------------- | ------------- | ------------------------- | ----------------------------------------------------------------------------------------- |
| `env` | string | 'production' | To set env to production | | `env` | string | 'production' | To set env to production |
| `title` | string | 'My Blog' | To set title | | `title` | string | 'My Blog' | To set title |
| `description` | string | 'This is a blog of mine' | To set site description | | `description` | string | 'This is a blog of mine' | To set site description |
@ -32,7 +32,10 @@
| `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 |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post | | `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page | | `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 |
| `comments` | boolean | true \| false | To show/hide comments | | `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 |
| `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics | | `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics |
| `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing | | `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing |
| `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex | | `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex |
@ -156,18 +159,24 @@ editPost:
| `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 |
| `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 | | `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 |
| `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings | | `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings |
| `searchHidden` | boolean | true \| false | Hide page from search | | `searchHidden` | boolean | true \| false | Hide page from search |
| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages | | `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 | | `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page | | `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post | | `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 | | `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| `cover.image` | string | 'featured.jpg' | To add a cover image | | `cover.image` | string | 'featured.jpg' | To add a cover image |
| `cover.caption ` | string | 'caption for image' | To add caption to 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.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.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 | | `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 | | `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 |