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

Aditya Telange 2021-01-20 20:57:39 +05:30
parent 7a3f914f0b
commit e2abafcfe4
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
4 changed files with 124 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
Home.md

@ -2,36 +2,25 @@
## What is hugo-PaperMod ? ## 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/ 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)
--- - ### [hugo-PaperMod - Variables](./Variables)
## Icons
Read Wiki => [hugo-PaperMod - Icons](./Icons)
---
## FAQs
Read Wiki => [hugo-PaperMod - FAQs](./FAQs)
---
## Variables
Read Wiki => [hugo-PaperMod - Variables](./Variables)

50
Icons.md

@ -3,16 +3,6 @@
## Social Icons ## Social Icons
Usage :
```
socialIcons: # optional
- name: "<NAME>"
url: "<link>"
- name: "<NAME>"
url: "<link2>"
```
| No. | name | platform link | | No. | name | platform link |
| --- | ------------- | ------------------------------- | | --- | ------------- | ------------------------------- |
| 1 | 123rf | 123rf.com | | 1 | 123rf | 123rf.com |
@ -42,20 +32,32 @@ socialIcons: # optional
| 25 | mastodon | mastodon.social | | 25 | mastodon | mastodon.social |
| 26 | medium | medium.com | | 26 | medium | medium.com |
| 27 | mixcloud | mixcloud.com | | 27 | mixcloud | mixcloud.com |
| 28 | paypal | paypal.com | | 28 | nuget | nuget.org |
| 29 | qq | qq.com | | 29 | paypal | paypal.com |
| 30 | rss | - | | 30 | qq | qq.com |
| 31 | soundcloud | soundcloud.com | | 31 | reddit | reddit.com |
| 32 | shutterstock | shutterstock.com | | 32 | rss | - |
| 33 | slack | slack.com | | 33 | soundcloud | soundcloud.com |
| 34 | sourcerer | sourcerer.io | | 34 | shutterstock | shutterstock.com |
| 35 | stackoverflow | stackoverflow.com | | 35 | slack | slack.com |
| 36 | steam | steampowered.com | | 36 | sourcerer | sourcerer.io |
| 37 | telegram | telegram.org | | 37 | stackoverflow | stackoverflow.com |
| 38 | twitch | twitch.tv | | 38 | steam | steampowered.com |
| 39 | twitter | twitter.com | | 39 | telegram | telegram.org |
| 40 | youtube | youtube.com | | 40 | twitch | twitch.tv |
| 41 | other | - | | 41 | twitter | twitter.com |
| 42 | youtube | youtube.com |
| 43 | other | - |
Usage :
```
socialIcons: # optional
- name: "<NAME>"
url: "<link>"
- name: "<NAME>"
url: "<link2>"
```
--- ---

42
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` ## Sample `config.yml`
> **Example Site Structure is present here**: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/) > **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" baseURL: "https://examplesite.com"
title: ExampleSite title: ExampleSite
paginate: 5 paginate: 5
theme: hugo-PaperMod theme: PaperMod
enableRobotsTXT: true enableRobotsTXT: true
buildDrafts: false buildDrafts: false
@ -90,18 +104,21 @@ params:
description: "ExampleSite description" description: "ExampleSite description"
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>"]
defaultTheme: auto # dark, light
disableThemeToggle: false
ShowReadingTime: true ShowReadingTime: true
ShowShareButtons: true ShowShareButtons: true
comments: false
defaultTheme: auto
disableThemeToggle: false
disableSpecial1stPost: false disableSpecial1stPost: false
comments: false
hidemeta: false
showtoc: false
tocopen: false
assets: assets:
# disableHLJS: true # to disable highlightjs # disableHLJS: true # to disable highlight.js
# disableFingerprinting: true # disableFingerprinting: true
favicon: "<link / abs url>" favicon: "<link / abs url>"
favicon16x16: "<link / abs url>" favicon16x16: "<link / abs url>"
@ -184,8 +201,8 @@ menu:
--- ---
title: "My 1st post" title: "My 1st post"
date: 2020-09-15T11:30:03+00:00 date: 2020-09-15T11:30:03+00:00
weight: 1 # weight: 1
aliases: ["/first"] # aliases: ["/first"]
tags: ["first"] tags: ["first"]
author: "Me" author: "Me"
# author: ["Me", "You"] # multiple authors # author: ["Me", "You"] # multiple authors
@ -193,18 +210,19 @@ showToc: true
TocOpen: false TocOpen: false
draft: false draft: false
hidemeta: false hidemeta: false
comments: false
description: "Desc Text."
disableHLJS: true # to disable highlightjs
disableShare: false disableShare: false
disableHLJS: false
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
comments: false
description: "Desc Text."
disableHLJS: true # to disable highlightjs
---
---
``` ```
--- ---

94
Variables.md

@ -3,47 +3,65 @@
--- ---
### Site Variables ### 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 |
| author | ["Me","You"] | list | 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| comments | boolean | true \| false | To show/hide comments | | comments | boolean | true \| false | To show/hide comments |
| | | | | | fuseOpts | | | |
| label.text | string | 'Home' | To display different label text other than title | | socialIcons | | | |
| label.icon | string | '/apple-touch-icon.png' | To display a logo image in label | | analytics.google.SiteVerificationTag | string | "XYZabc" | |
| 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 | | label.text | string | 'Home' | To display different label text other than title |
| cover.linkFullImages | boolean | true \| false | To open full size cover images on click on cover | | label.icon | string | '/apple-touch-icon.png' | To display a logo image in label |
| cover.responsiveImages | boolean | true \| false | To enable/disable generation of responsive cover images | | 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 ### Page Variables
| Name | Type | Example | Description | | Name | Type | Example | Description |
| -------------- | ------------ | --------------------- | ----------------------------------------------------------------------------------- | | -------------- | ------------- | --------------------- | ----------------------------------------------------------------------------------- |
| 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 |
| 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 |
| cover.image | string | 'featured.jpg' | To add a cover image | | comments | boolean | true \| false | To show/hide comments |
| cover.caption | string | 'caption for image' | To add caption to cover image | | description | string | 'description text' | Show Post Description under Title |
| cover.alt | string | 'this is cover image' | Alternate text to show if image doesn't load/show up | | disableShare | boolean | true \| false | To hide/show share icons under a page |
| cover.relative | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles | | disableHLJS | | | |
| comments | boolean | true \| false | To show/hide comments | | author | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| disableShare | boolean | true \| false | To hide/show share icons under a page | | cover.image | string | 'featured.jpg' | To add a cover image |
| author | ["Me","You"] | list | To show multiple Authors | | 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 |
| weight | integer | 5 | To set page order or to pin a post to Top of list | | 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 |