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

add icons and vars

Browse Source 
link vars on install page
This commit is contained in:
Aditya Telange 2021-01-20 20:17:35 +05:30
parent 512b553094
commit e11876191a
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
5 changed files with 109 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/posts/papermod/papermod-faq.md
View File

@ -1,7 +1,7 @@
---
title: "FAQs"
summary: Frequently Asked Questions
date: 2020-09-18T11:30:03+05:30
date: 2021-01-20
showtoc: true
tocOpen: true
aliases: ["/papermod-how-to-guide"]

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

@ -1,7 +1,7 @@
---
title: "Features"
summary: Get known about All Features in PaperMod
date: 2020-09-16T11:30:03+05:30
date: 2021-01-20
showToc: true
weight: 2
aliases: ["/papermod-features"]

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

@ -1,10 +1,10 @@
---
title: "Icons"
summary: List of all Icons supported by PaperMod
date: 2020-09-17T11:30:03+05:30
date: 2021-01-20
showtoc: true
tocopen: true
weight: 3
weight: 4
aliases: ["/papermod-icons"]
tags: ["PaperMod"]
author: "Aditya Telange"
@ -13,18 +13,8 @@ draft: true
## Social Icons
Usage :
```
socialIcons: # optional
- name: "<NAME>"
url: "<link>"
- name: "<NAME>"
url: "<link2>"
```
| No. | name | platform link |
| --- | ------------- | ----------------- |
| --- | ------------- | ------------------------------- |
| 1 | 123rf | 123rf.com |
| 2 | adobestock | stock.adobe.com |
| 3 | behance | behance.net |
@ -52,20 +42,32 @@ socialIcons: # optional
| 25 | mastodon | mastodon.social |
| 26 | medium | medium.com |
| 27 | mixcloud | mixcloud.com |
| 28 | paypal | paypal.com |
| 29 | qq | qq.com |
| 30 | rss | - |
| 31 | soundcloud | soundcloud.com |
| 32 | shutterstock | shutterstock.com |
| 33 | slack | slack.com |
| 34 | sourcerer | sourcerer.io |
| 35 | stackoverflow | stackoverflow.com |
| 36 | steam | steampowered.com |
| 37 | telegram | telegram.org |
| 38 | twitch | twitch.tv |
| 39 | twitter | twitter.com |
| 40 | youtube | youtube.com |
| 41 | other | - |
| 28 | nuget | nuget.org |
| 29 | paypal | paypal.com |
| 30 | qq | qq.com |
| 31 | reddit | reddit.com |
| 32 | rss | - |
| 33 | soundcloud | soundcloud.com |
| 34 | shutterstock | shutterstock.com |
| 35 | slack | slack.com |
| 36 | sourcerer | sourcerer.io |
| 37 | stackoverflow | stackoverflow.com |
| 38 | steam | steampowered.com |
| 39 | telegram | telegram.org |
| 40 | twitch | twitch.tv |
| 41 | twitter | twitter.com |
| 42 | youtube | youtube.com |
| 43 | other | - |
Usage :
```
socialIcons: # optional
- name: "<NAME>"
url: "<link>"
- name: "<NAME>"
url: "<link2>"
```
---

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

@ -1,7 +1,7 @@
---
title: "Installation | Update"
summary: Read Install and Update instructions here
date: 2020-09-15T11:30:03+05:30
date: 2021-01-20
series: ["PaperMod"]
weight: 1
aliases: ["/papermod-installation"]
@ -70,7 +70,9 @@ theme: "PaperMod"
- ### [Papermod - Features](../papermod-features)
- ### [Papermod - How to Guide](../papermod-how-to)
- ### [Papermod - FAQs](../papermod-how-to)
- ### [Papermod - Variables](../papermod-variables)
- ### [Papermod - Icons](../papermod-icons)
@ -88,7 +90,7 @@ theme: "PaperMod"
baseURL: "https://examplesite.com"
title: ExampleSite
paginate: 5
theme: hugo-PaperMod
theme: PaperMod
enableRobotsTXT: true
buildDrafts: false
@ -107,18 +109,21 @@ params:
description: "ExampleSite description"
author: Me
# author: ["Me", "You"] # multiple authors
images: ["<link or path of image for opengraph, twitter-cards>"]
defaultTheme: auto # dark, light
disableThemeToggle: false
ShowReadingTime: true
ShowShareButtons: true
comments: false
defaultTheme: auto
disableThemeToggle: false
disableSpecial1stPost: false
comments: false
hidemeta: false
showtoc: false
tocopen: false
assets:
# disableHLJS: true # to disable highlightjs
# disableHLJS: true # to disable highlight.js
# disableFingerprinting: true
favicon: "<link / abs url>"
favicon16x16: "<link / abs url>"
@ -201,8 +206,8 @@ menu:
---
title: "My 1st post"
date: 2020-09-15T11:30:03+00:00
weight: 1
aliases: ["/first"]
# weight: 1
# aliases: ["/first"]
tags: ["first"]
author: "Me"
# author: ["Me", "You"] # multiple authors
@ -210,18 +215,19 @@ showToc: true
TocOpen: false
draft: false
hidemeta: false
comments: false
description: "Desc Text."
disableHLJS: true # to disable highlightjs
disableShare: false
disableHLJS: false
cover:
image: "<image path/url>" # image path/url
alt: "<alt text>" # alt text
caption: "<text>" # display caption under cover
relative: false # when using page bundles set this to true
hidden: true # only hide on current single page
comments: false
description: "Desc Text."
disableHLJS: true # to disable highlightjs
---
---
```
---

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

@ -1,59 +1,78 @@
---
title: "Variables | Front Matter"
summary: List of Front Matter variables used by PaperMod
date: 2020-09-24T11:33:33+05:30
date: 2021-01-20
showToc: true
TocOpen: true
tags: ["PaperMod"]
author: "Aditya Telange"
draft: true
weight: 5
---
**Below are variables used with this theme...**
---
### Site Variables
### Site Variables under `Params`
| name | type | example | Description |
| ---------------------- | ------------ | ------------------------ | ----------------------------------------------------------------------------------- |
| env | string | 'production' | To set env to production |
| title | string | 'My Blog' | To set title |
| description | string | 'This is a blog of mine' | To set site description |
| author | ["Me","You"] | list | To show multiple Authors |
| images | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards |
| ShowReadingTime | boolean | true \| false | To show read time in post meta |
| ShowShareButtons | boolean | true \| false | To show/hide share buttons under post |
| defaultTheme | string | light \| dark \| auto | To set default theme |
| 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 |
| hidemeta | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page |
| showtoc | boolean | true \| false | To show/hide Table of Contents |
| tocopen | boolean | true \| false | To keep open ToC by default on page load |
| comments | boolean | true \| false | To show/hide comments |
| | | | |
| label.text | string | 'Home' | To display different label text other than title |
| label.icon | string | '/apple-touch-icon.png' | To display a logo image in label |
| label.iconHeight | integer | 35 | To set size of label logo image |
| assets.favicon | string | 'icon.ico' | To set favicon, can be path or external link |
| cover.linkFullImages | boolean | true \| false | To open full size cover images on click on cover |
| cover.responsiveImages | boolean | true \| false | To enable/disable generation of responsive cover images |
| name | type | example | Description |
| ------------------------------------ | ------------- | ------------------------ | ----------------------------------------------------------------------------------- |
| env | string | 'production' | To set env to production |
| title | string | 'My Blog' | To set title |
| description | string | 'This is a blog of mine' | To set site description |
| author | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| images | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards |
| ShowReadingTime | boolean | true \| false | To show read time in post meta |
| ShowShareButtons | boolean | true \| false | To show/hide share buttons under post |
| defaultTheme | string | light \| dark \| auto | To set default theme |
| 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 |
| hidemeta | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page |
| showtoc | boolean | true \| false | To show/hide Table of Contents |
| tocopen | boolean | true \| false | To keep open ToC by default on page load |
| comments | boolean | true \| false | To show/hide comments |
| fuseOpts | | | |
| socialIcons | | | |
| analytics.google.SiteVerificationTag | string | "XYZabc" | |
| | | | |
| label.text | string | 'Home' | To display different label text other than title |
| label.icon | string | '/apple-touch-icon.png' | To display a logo image in label |
| label.iconHeight | integer | 35 | To set size of label logo image |
| assets.favicon | string | 'icon.ico' | To set favicon, can be path or external link |
| assets.disableHLJS | | | |
| assets.disableFingerprinting | | | |
| cover.linkFullImages | boolean | true \| false | To open full size cover images on click on cover |
| cover.responsiveImages | boolean | true \| false | To enable/disable generation of responsive cover images |
| cover.hidden | | | |
| cover.hiddenInList | | | |
| cover.hiddenInSingle | | | |
| profileMode.enabled | | | |
| profileMode.title | | | |
| profileMode.imageUrl | | | |
| profileMode.imageWidth | | | |
| profileMode.imageHeight | | | |
| profileMode.imageTitle | | | |
| profileMode.buttons | | | |
---
### 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 |
| 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 |
| comments | boolean | true \| false | To show/hide comments |
| disableShare | boolean | true \| false | To hide/show share icons under a page |
| author | ["Me","You"] | list | To show multiple Authors |
| | | | |
| weight | integer | 5 | To set page order or to pin a post to Top of list |
| 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 |
| disableShare | boolean | true \| false | To hide/show share icons under a page |
| disableHLJS | | | |
| 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.hidden | | | |
| | | | |
| weight | integer | 5 | To set page order or to pin a post to Top of list |