From e11876191ac5881eec9a76c6b8f48566ed4edd8b Mon Sep 17 00:00:00 2001 From: Aditya Telange <21258296+adityatelange@users.noreply.github.com> Date: Wed, 20 Jan 2021 20:17:35 +0530 Subject: [PATCH] add icons and vars link vars on install page --- content/posts/papermod/papermod-faq.md | 2 +- .../posts/papermod/papermod-features/index.md | 2 +- content/posts/papermod/papermod-icons.md | 56 +++++------ .../posts/papermod/papermod-installation.md | 34 ++++--- content/posts/papermod/papermod-variables.md | 97 +++++++++++-------- 5 files changed, 109 insertions(+), 82 deletions(-) diff --git a/content/posts/papermod/papermod-faq.md b/content/posts/papermod/papermod-faq.md index 8f4f6c04..9a0fae2c 100644 --- a/content/posts/papermod/papermod-faq.md +++ b/content/posts/papermod/papermod-faq.md @@ -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"] diff --git a/content/posts/papermod/papermod-features/index.md b/content/posts/papermod/papermod-features/index.md index e14e7bdd..955d3087 100644 --- a/content/posts/papermod/papermod-features/index.md +++ b/content/posts/papermod/papermod-features/index.md @@ -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"] diff --git a/content/posts/papermod/papermod-icons.md b/content/posts/papermod/papermod-icons.md index 7ed44b53..5f628819 100644 --- a/content/posts/papermod/papermod-icons.md +++ b/content/posts/papermod/papermod-icons.md @@ -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: "" - url: "" - - name: "" - url: "" -``` - | 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: "" + url: "" + - name: "" + url: "" +``` --- diff --git a/content/posts/papermod/papermod-installation.md b/content/posts/papermod/papermod-installation.md index 4327c0fe..72dbcab3 100644 --- a/content/posts/papermod/papermod-installation.md +++ b/content/posts/papermod/papermod-installation.md @@ -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: [""] + 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: "" favicon16x16: "" @@ -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 alt: "" # alt text caption: "" # 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 ---- +--- ``` --- diff --git a/content/posts/papermod/papermod-variables.md b/content/posts/papermod/papermod-variables.md index 3b4e8a8d..f264aa38 100644 --- a/content/posts/papermod/papermod-variables.md +++ b/content/posts/papermod/papermod-variables.md @@ -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 |