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

Aditya Telange 2021-03-31 11:21:42 +05:30
parent 863a923e5d
commit 7cbd84a51b
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
3 changed files with 71 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
Icons.md

@ -13,47 +13,49 @@
| 4 | `buymeacoffee` | buymeacoffee.com | | 4 | `buymeacoffee` | buymeacoffee.com |
| 5 | `codepen` | codepen.io | | 5 | `codepen` | codepen.io |
| 6 | `cryptohack` | cryptohack.org | | 6 | `cryptohack` | cryptohack.org |
| 7 | `dev` | dev.to | | 7 | `ctftime` | ctftime.org |
| 8 | `discogs` | discogs.com | | 8 | `dev` | dev.to |
| 9 | `discord` | discord.com | | 9 | `discogs` | discogs.com |
| 10 | `dreamstime` | dreamstime.com | | 10 | `discord` | discord.com |
| 11 | `dribbble` | dribbble.com | | 11 | `dreamstime` | dreamstime.com |
| 12 | `email` | - | | 12 | `dribbble` | dribbble.com |
| 13 | `facebook` | facebook.com | | 13 | `email` | - |
| 14 | `freepik` | freepik.com | | 14 | `facebook` | facebook.com |
| 15 | `github` | github.com | | 15 | `freepik` | freepik.com |
| 16 | `gitlab` | gitlab.com | | 16 | `gitea` | gitea.io |
| 17 | `gitea` | gitea.io | | 17 | `github` | github.com |
| 18 | `hackerrank` | hackerrank.com | | 18 | `gitlab` | gitlab.com |
| 19 | `hackthebox` | hackthebox.eu | | 19 | `hackerone` | hackerone.com |
| 20 | `instagram` | instagram.com | | 20 | `hackerrank` | hackerrank.com |
| 21 | `itchio` | itch.io | | 21 | `hackthebox` | hackthebox.eu |
| 22 | `kakaotalk` | kakaocorp.com/service/KakaoTalk | | 22 | `instagram` | instagram.com |
| 23 | `keybase` | keybase.io | | 23 | `itchio` | itch.io |
| 24 | `kofi` | ko-fi.com | | 24 | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 25 | `lastfm` | last.fm | | 25 | `keybase` | keybase.io |
| 26 | `linkedin` | linkedin.com | | 26 | `kofi` | ko-fi.com |
| 27 | `mastodon` | mastodon.social | | 27 | `lastfm` | last.fm |
| 28 | `medium` | medium.com | | 28 | `linkedin` | linkedin.com |
| 29 | `mixcloud` | mixcloud.com | | 29 | `mastodon` | mastodon.social |
| 30 | `nuget` | nuget.org | | 30 | `medium` | medium.com |
| 31 | `paypal` | paypal.com | | 31 | `mixcloud` | mixcloud.com |
| 32 | `qq` | qq.com | | 32 | `nuget` | nuget.org |
| 33 | `reddit` | reddit.com | | 33 | `paypal` | paypal.com |
| 34 | `rss` | - | | 34 | `qq` | qq.com |
| 35 | `soundcloud` | soundcloud.com | | 35 | `reddit` | reddit.com |
| 36 | `shutterstock` | shutterstock.com | | 36 | `rss` | - |
| 37 | `slack` | slack.com | | 37 | `soundcloud` | soundcloud.com |
| 38 | `snapchat` | snapchat.com/add | | 38 | `shutterstock` | shutterstock.com |
| 39 | `sourcerer` | sourcerer.io | | 39 | `slack` | slack.com |
| 40 | `stackoverflow` | stackoverflow.com | | 40 | `snapchat` | snapchat.com/add |
| 41 | `steam` | steampowered.com | | 41 | `sourcerer` | sourcerer.io |
| 42 | `telegram` | telegram.org | | 42 | `stackoverflow` | stackoverflow.com |
| 43 | `twitch` | twitch.tv | | 43 | `steam` | steampowered.com |
| 44 | `twitter` | twitter.com | | 44 | `telegram` | telegram.org |
| 45 | `unsplash` | unsplash.com | | 45 | `twitch` | twitch.tv |
| 46 | `youtube` | youtube.com | | 46 | `twitter` | twitter.com |
| 47 | `other` | - | | 47 | `unsplash` | unsplash.com |
| 48 | `youtube` | youtube.com |
| 49 | `other` | - |
Usage : Usage :

30
Installation.md

@ -37,7 +37,7 @@ Inside the folder of your Hugo site, run:
git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1 git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1
``` ```
**Note**: You may use ` --branch v3.0` to end of above command if you want to stick to specific release. **Note**: You may use ` --branch v5.0` to end of above command if you want to stick to specific release.
> Updating theme : > Updating theme :
> >
@ -55,7 +55,7 @@ git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/Pape
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)
``` ```
**Note**: You may use ` --branch v4.0` to end of above command if you want to stick to specific release. **Note**: You may use ` --branch v5.0` to end of above command if you want to stick to specific release.
> Updating theme : > Updating theme :
> >
@ -70,6 +70,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)
- [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)
- [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip) - [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip)
@ -128,18 +129,23 @@ params:
env: production # to enable google analytics, opengraph, twitter-cards and schema. env: production # to enable google analytics, opengraph, twitter-cards and schema.
title: ExampleSite title: ExampleSite
description: "ExampleSite description" description: "ExampleSite description"
keywords: [Blog, Portfolio, PaperMod]
author: Me author: Me
# author: ["Me", "You"] # multiple authors # author: ["Me", "You"] # multiple authors
images: ["<link or path of image for opengraph, twitter-cards>"] images: ["<link or path of image for opengraph, twitter-cards>"]
DateFormat: "January 2, 2006"
defaultTheme: auto # dark, light defaultTheme: auto # dark, light
disableThemeToggle: false disableThemeToggle: false
ShowReadingTime: true ShowReadingTime: true
ShowShareButtons: true ShowShareButtons: true
ShowPostNavLinks: true
ShowBreadCrumbs: true
disableSpecial1stPost: false disableSpecial1stPost: false
disableScrollToTop: false
comments: false comments: false
hidemeta: false hidemeta: false
hideSummary: false
showtoc: false showtoc: false
tocopen: false tocopen: false
@ -188,12 +194,21 @@ params:
analytics: analytics:
google: google:
SiteVerificationTag: "XYZabc" SiteVerificationTag: "XYZabc"
bing:
SiteVerificationTag: "XYZabc"
yandex:
SiteVerificationTag: "XYZabc"
cover: cover:
hidden: true # hide everywhere but not in structured data hidden: true # hide everywhere but not in structured data
hiddenInList: true # hide on list pages and home hiddenInList: true # hide on list pages and home
hiddenInSingle: true # hide on single page hiddenInSingle: true # hide on single page
editPost:
URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link
# for search # for search
# https://fusejs.io/api/options.html # https://fusejs.io/api/options.html
fuseOpts: fuseOpts:
@ -251,14 +266,21 @@ description: "Desc Text."
disableHLJS: true # to disable highlightjs disableHLJS: true # to disable highlightjs
disableShare: false disableShare: false
disableHLJS: false disableHLJS: false
hideSummary: false
searchHidden: true searchHidden: true
ShowReadingTime: true
ShowBreadCrumbs: true
ShowPostNavLinks: 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
caption: "<text>" # display caption under cover caption: "<text>" # display caption under cover
relative: false # when using page bundles set this to true relative: false # when using page bundles set this to true
hidden: true # only hide on current single page hidden: true # only hide on current single page
editPost:
URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link
--- ---
``` ```

3
Variables.md

@ -14,6 +14,7 @@
| `description` | string | 'This is a blog of mine' | To set site description | | `description` | string | 'This is a blog of mine' | To set site description |
| `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | | `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards | | `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards |
| `keywords` | list | [blog, page] | Add keywords for Home page |
| `DateFormat` | string | "January 2, 2006" | The format of date strings in the website. [Details](https://gohugo.io/functions/format/) | | `DateFormat` | string | "January 2, 2006" | The format of date strings in the website. [Details](https://gohugo.io/functions/format/) |
| `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 |
@ -21,7 +22,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 |
| `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 |
| `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 |