diff --git a/Home.md b/Home.md index 820f9ff..f04b65a 100644 --- a/Home.md +++ b/Home.md @@ -2,36 +2,25 @@ ## What is hugo-PaperMod ? -This is a modified theme for [Hugo static site generator](https://gohugo.io/), modded from [hugo-paper](https://github.com/nanxiaobei/hugo-paper) by [nanxiaobei](https://github.com/nanxiaobei). +Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper). +The goal of this project is add more Features and customization to the og theme. + +The [demo site](https://adityatelange.github.io/hugo-PaperMod/) includes a lot of documentation about Installation, Features with few more stuff. Make sure you visit it, to get the awesome hands-on experience and get known about the features ... + +ExampleSite can be found here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite). Demo is built up with exampleSite as source. Demo Site : https://adityatelange.github.io/hugo-PaperMod/ --- -## Install +## Quick Links -Read Wiki => [hugo-PaperMod - Installation](./Installation) +- ### [hugo-PaperMod - Installation](./Installation) ---- +- ### [hugo-PaperMod - Features](./Features) -## Features/Mods +- ### [hugo-PaperMod - Icons](./Icons) -Read Wiki => [hugo-PaperMod - Features](./Features) +- ### [hugo-PaperMod - FAQs](./FAQs) ---- - -## Icons - -Read Wiki => [hugo-PaperMod - Icons](./Icons) - ---- - -## FAQs - -Read Wiki => [hugo-PaperMod - FAQs](./FAQs) - ---- - -## Variables - -Read Wiki => [hugo-PaperMod - Variables](./Variables) +- ### [hugo-PaperMod - Variables](./Variables) diff --git a/Icons.md b/Icons.md index df3addb..2fa8a1d 100644 --- a/Icons.md +++ b/Icons.md @@ -3,16 +3,6 @@ ## Social Icons -Usage : - -``` -socialIcons: # optional - - name: "" - url: "" - - name: "" - url: "" -``` - | No. | name | platform link | | --- | ------------- | ------------------------------- | | 1 | 123rf | 123rf.com | @@ -42,20 +32,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/Installation.md b/Installation.md index b6499a1..0ba7514 100644 --- a/Installation.md +++ b/Installation.md @@ -61,6 +61,20 @@ theme: "PaperMod" --- +## Quick Links + +- ### [PaperMod - Installation](./Installation) + +- ### [PaperMod - Features](./Features) + +- ### [PaperMod - Icons](./Icons) + +- ### [PaperMod - FAQs](./FAQs) + +- ### [PaperMod - Variables](./Variables) + +--- + ## Sample `config.yml` > **Example Site Structure is present here**: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/) @@ -71,7 +85,7 @@ theme: "PaperMod" baseURL: "https://examplesite.com" title: ExampleSite paginate: 5 -theme: hugo-PaperMod +theme: PaperMod enableRobotsTXT: true buildDrafts: false @@ -90,18 +104,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: "" @@ -184,8 +201,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 @@ -193,18 +210,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/Variables.md b/Variables.md index 3cefff9..0b06b08 100644 --- a/Variables.md +++ b/Variables.md @@ -3,47 +3,65 @@ --- -### 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 |