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 from wiki and prettify

Browse Source
This commit is contained in:
Aditya Telange 2022-06-10 21:49:13 +05:30
parent 5c8078a888
commit fb3fb4d325
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
4 changed files with 346 additions and 294 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
content/posts/papermod/papermod-features/index.md
View File

@ -22,7 +22,7 @@ The following is enabled by default
- [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible. - [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible.
- [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset - [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset
- [fingerprint/integrity](https://gohugo.io/hugo-pipes/fingerprint/) check. - [fingerprint/intergity](https://gohugo.io/hugo-pipes/fingerprint/) check.
--- ---
@ -86,7 +86,6 @@ layout: "archives"
url: "/archives/" url: "/archives/"
summary: archives summary: archives
--- ---
``` ```
**Note:** Archives Layout does not support Multilingual Month Translations. **Note:** Archives Layout does not support Multilingual Month Translations.
@ -122,8 +121,6 @@ params:
url: "<link2>" url: "<link2>"
``` ```
ex. [config.yml#L106](https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.yml#L106)
--- ---
### Profile Mode ### Profile Mode
@ -182,8 +179,8 @@ 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"
--- ---
``` ```
To hide a particular page from being searched, add it in post's fron't matter To hide a particular page from being searched, add it in post's fron't matter
@ -322,7 +319,6 @@ Can be diabled for particular page's front-matter
--- ---
ShowBreadCrumbs: false ShowBreadCrumbs: false
--- ---
``` ```
--- ---
@ -350,7 +346,6 @@ editPost:
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
--- ---
``` ```
The example above would yield the following link for the post file `posts/post-name.md`: The example above would yield the following link for the post file `posts/post-name.md`:
@ -379,6 +374,17 @@ params:
--- ---
### Code Copy Button
Adds a `copy` button in code block to copy the code it contains
```yml
params:
ShowCodeCopyButtons: true
```
---
### Multiple Authors ### Multiple Authors
To Use multiple authors for a post, in post-variables: To Use multiple authors for a post, in post-variables:
@ -387,7 +393,6 @@ To Use multiple authors for a post, in post-variables:
--- ---
author: ["Me", "You"] author: ["Me", "You"]
--- ---
``` ```
To use Multiple Authors Site-wide, in `config.yml`: To use Multiple Authors Site-wide, in `config.yml`:

155
content/posts/papermod/papermod-icons.md
View File

@ -11,64 +11,84 @@ draft: true
## 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 | | `apple music` | music.apple.com |
| 4 | `buymeacoffee` | buymeacoffee.com | | `behance` | behance.net |
| 5 | `codepen` | codepen.io | | `bilibili` | bilibili.com |
| 6 | `cryptohack` | cryptohack.org | | `bitcoin` | - |
| 7 | `ctftime` | ctftime.org | | `buymeacoffee` | buymeacoffee.com |
| 8 | `dev` | dev.to | | `codepen` | codepen.io |
| 9 | `discogs` | discogs.com | | `cryptohack` | cryptohack.org |
| 10 | `discord` | discord.com | | `ctftime` | ctftime.org |
| 11 | `dreamstime` | dreamstime.com | | `cv` | - |
| 12 | `dribbble` | dribbble.com | | `deezer` | deezer.com |
| 13 | `email` | - | | `dev` | dev.to |
| 14 | `facebook` | facebook.com | | `discogs` | discogs.com |
| 15 | `flickr` | flickr.com | | `discord` | discord.com |
| 16 | `freepik` | freepik.com | | `dreamstime` | dreamstime.com |
| 17 | `gitea` | gitea.io | | `dribbble` | dribbble.com |
| 18 | `github` | github.com | | `email` | - |
| 19 | `gitlab` | gitlab.com | | `facebook` | facebook.com |
| 20 | `goodreads` | goodreads.com | | `flickr` | flickr.com |
| 21 | `hackerone` | hackerone.com | | `freepik` | freepik.com |
| 22 | `hackerrank` | hackerrank.com | | `gitea` | gitea.io |
| 23 | `hackthebox` | hackthebox.eu | | `github` | github.com |
| 24 | `instagram` | instagram.com | | `gitlab` | gitlab.com |
| 25 | `itchio` | itch.io | | `goodreads` | goodreads.com |
| 26 | `kakaotalk` | kakaocorp.com/service/KakaoTalk | | `googlescholar` | scholar.google.com |
| 27 | `keybase` | keybase.io | | `guruShots` | gurushots.com |
| 28 | `kofi` | ko-fi.com | | `hackerone` | hackerone.com |
| 29 | `lastfm` | last.fm | | `hackerrank` | hackerrank.com |
| 30 | `liberapay` | liberapay.com | | `hackthebox` | hackthebox.eu |
| 31 | `linkedin` | linkedin.com | | `instagram` | instagram.com |
| 32 | `mastodon` | mastodon.social | | `itchio` | itch.io |
| 33 | `matrix` | matrix.org | | `kaggle` | - |
| 34 | `medium` | medium.com | | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 35 | `mixcloud` | mixcloud.com | | `key` | - |
| 36 | `nuget` | nuget.org | | `keybase` | keybase.io |
| 37 | `paypal` | paypal.com | | `kofi` | ko-fi.com |
| 38 | `qq` | qq.com | | `komoot` | - |
| 39 | `reddit` | reddit.com | | `lastfm` | last.fm |
| 40 | `rss` | - | | `letterboxd` | - |
| 41 | `serverfault` | serverfault.com | | `liberapay` | liberapay.com |
| 42 | `soundcloud` | soundcloud.com | | `linkedin` | linkedin.com |
| 43 | `shutterstock` | shutterstock.com | | `mastodon` | mastodon.social |
| 44 | `slack` | slack.com | | `matrix` | matrix.org |
| 45 | `snapchat` | snapchat.com/add | | `medium` | medium.com |
| 46 | `sourcerer` | sourcerer.io | | `monero` | - |
| 47 | `spotify` | spotify.com | | `mixcloud` | mixcloud.com |
| 48 | `stackoverflow` | stackoverflow.com | | `nuget` | nuget.org |
| 49 | `steam` | steampowered.com | | `paypal` | paypal.com |
| 50 | `telegram` | telegram.org | | `peertube` | - |
| 51 | `twitch` | twitch.tv | | `pgp` | - |
| 52 | `twitter` | twitter.com | | `phone` | - |
| 53 | `unsplash` | unsplash.com | | `ploywork` | ploywork.com |
| 54 | `xda` | xda-developers.com | | `qq` | qq.com |
| 55 | `youtube` | youtube.com | | `reddit` | reddit.com |
| 56 | `other` | - | | `researchgate` | researchgate.net |
| `rss` | - |
| `serverfault` | serverfault.com |
| `soundcloud` | soundcloud.com |
| `shutterstock` | shutterstock.com |
| `slack` | slack.com |
| `snapchat` | snapchat.com/add |
| `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 |
| `xda` | xda-developers.com |
| `xing` | xing.com |
| `ycombinator` | ycombinator.com |
| `youtube` | youtube.com |
| `other` | - |
Usage : Usage :
@ -85,13 +105,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:
@ -99,3 +119,8 @@ Usage:
params: params:
ShowShareButtons: true ShowShareButtons: true
``` ```
```yml
params:
ShareButtons: ["linkedin", "twitter"] # To customize which share buttons to be enabled on page
```

20
content/posts/papermod/papermod-installation.md
View File

@ -47,10 +47,10 @@ git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth
### Method 2 ### Method 2
You can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with you can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with
```bash ```bash
git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1 git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod
git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically) git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically)
``` ```
@ -69,6 +69,7 @@ Or you can Download as Zip from Github Page and extract in your themes directory
Direct Links: Direct Links:
- [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip) - [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip)
- [v6.0](https://github.com/adityatelange/hugo-PaperMod/archive/v6.0.zip)
- [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip) - [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip)
- [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip) - [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip)
- [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip) - [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip)
@ -137,7 +138,6 @@ enableRobotsTXT: true
buildDrafts: false buildDrafts: false
buildFuture: false buildFuture: false
buildExpired: false buildExpired: false
pygmentsUseClasses: true
googleAnalytics: UA-123-45 googleAnalytics: UA-123-45
@ -162,6 +162,9 @@ params:
ShowPostNavLinks: true ShowPostNavLinks: true
ShowBreadCrumbs: true ShowBreadCrumbs: true
ShowCodeCopyButtons: false ShowCodeCopyButtons: false
ShowWordCount: true
ShowRssButtonInSectionTermList: true
UseHugoToc: true
disableSpecial1stPost: false disableSpecial1stPost: false
disableScrollToTop: false disableScrollToTop: false
comments: false comments: false
@ -255,10 +258,11 @@ menu:
url: https://example.org url: https://example.org
weight: 30 weight: 30
# Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma # Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma
# pygmentsUseClasses: true pygmentsUseClasses: true
# markup: markup:
# highlight: highlight:
# # anchorLineNos: true noClasses: false
# anchorLineNos: true
# codeFences: true # codeFences: true
# guessSyntax: true # guessSyntax: true
# lineNos: true # lineNos: true
@ -293,7 +297,9 @@ searchHidden: true
ShowReadingTime: true ShowReadingTime: true
ShowBreadCrumbs: true ShowBreadCrumbs: true
ShowPostNavLinks: true ShowPostNavLinks: true
ShowWordCount: true
ShowRssButtonInSectionTermList: true ShowRssButtonInSectionTermList: true
UseHugoToc: true
cover: cover:
image: "<image path/url>" # image path/url image: "<image path/url>" # image path/url
alt: "<alt text>" # alt text alt: "<alt text>" # alt text

24
content/posts/papermod/papermod-variables.md
View File

@ -15,7 +15,7 @@ weight: 5
### 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 |
@ -27,7 +27,6 @@ weight: 5
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta | | `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post | | `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post |
| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button | | `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button |
| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show/hide RSS Copy button in Section and Term list |
| `ShowFullTextinRSS` | boolean | true \| false | To show Content in RSS feed | | `ShowFullTextinRSS` | boolean | true \| false | To show Content in RSS feed |
| `defaultTheme` | string | light \| dark \| auto | To set default theme | | `defaultTheme` | string | light \| dark \| auto | To set default theme |
| `disableThemeToggle` | boolean | true \| false | To disable theme toggle icon shown besides label | | `disableThemeToggle` | boolean | true \| false | To disable theme toggle icon shown besides label |
@ -40,7 +39,13 @@ weight: 5
| `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 |
| `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 | | `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 |
@ -94,10 +99,12 @@ profileMode:
#### assets #### assets
| name | type | example | Description | | name | type | example | Description |
| ------------------------------ | ------- | ------------- | -------------------------------------------- | | -------------------------------- | ------- | ------------- | -------------------------------------------- |
| `assets.favicon` | string | 'icon.ico' | To set favicon, can be path or external link | | `assets.favicon` | string | 'icon.ico' | To set favicon, can be path or external link |
| `assets.disableHLJS` | boolean | true \| false | To disable Highlight.js loading | | `assets.disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| `assets.disableFingerprinting` | boolean | true \| false | To disable Sub-Resource integrity for assets | | `assets.disableFingerprinting` | boolean | true \| false | To disable Sub-Resource integrity for assets |
| `assets.theme_color` | string | '#color' | To set custom meta theme-color |
| `assets.msapplication_TileColor` | string | '#color' | To set custom msapplication_TileColor |
#### cover #### cover
@ -164,19 +171,28 @@ 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 |
| `ShowRssButtonInSectionTermList` | boolean | true \| false | To show/hide RSS Copy button in Section and Term list | | `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 |
| `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 |
| `robotsNoIndex` | boolean | true \| false | To hide a particular page from indexing by search engines |