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 upto 1033afc

Aditya Telange 2021-10-30 13:07:13 +05:30
parent 06a6720c54
commit c12676754c
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
8 changed files with 467 additions and 452 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

196
ChangeLog.md

@ -1,10 +1,10 @@
## ToC
- [v5.0](#v50)
- [v4.0](#v40)
- [v3.0](#v30)
- [v2.0](#v20)
- [v1.0](#v10)
- [v5.0](#v50)
- [v4.0](#v40)
- [v3.0](#v30)
- [v2.0](#v20)
- [v1.0](#v10)
---
@ -12,56 +12,56 @@
[Compare v4.0...v5.0](https://github.com/adityatelange/hugo-PaperMod/compare/v4.0...v5.0)
- Add Feature `ShowPostNavLinks` - shows Prev Next post links on single post page
- Add Feature `BreadCrumbNavigation` - adds Breadcrumb navigation above title of single page/post
- Add feature `editPost` - adds option to show link in meta data for editing posts
- Add support for `rtl` and `ltr` shortcodes
- Add Translations of `Japanese`, `Hungarian`, `Catalan`, `Uzbek`, `Hebrew`, `Arabic`, `Portuguese`
- Add social icons of `snapchat`, `gitea`, `unsplash`, `itchio`, `ctftime`
- Add browser-level lazy-loading of images
- Improve overall design to fit Prev Next post links and remove borders
- Improve scrollbar styling
- Tweak Fuse options for search
- Improve theme changes when JS is disabled
- Fix code highlight when HLJS is disabled
- Fix colors in embeded gist
- Fix `...` being shown for smaller summary in posts
- Update internal templates from hugo
- Miscellaneous improvements, fixes and accessibility enhancements
- Add Feature `ShowPostNavLinks` - shows Prev Next post links on single post page
- Add Feature `BreadCrumbNavigation` - adds Breadcrumb navigation above title of single page/post
- Add feature `editPost` - adds option to show link in meta data for editing posts
- Add support for `rtl` and `ltr` shortcodes
- Add Translations of `Japanese`, `Hungarian`, `Catalan`, `Uzbek`, `Hebrew`, `Arabic`, `Portuguese`
- Add social icons of `snapchat`, `gitea`, `unsplash`, `itchio`, `ctftime`
- Add browser-level lazy-loading of images
- Improve overall design to fit Prev Next post links and remove borders
- Improve scrollbar styling
- Tweak Fuse options for search
- Improve theme changes when JS is disabled
- Fix code highlight when HLJS is disabled
- Fix colors in embeded gist
- Fix `...` being shown for smaller summary in posts
- Update internal templates from hugo
- Miscellaneous improvements, fixes and accessibility enhancements
### v4.0
[Compare v3.0...v4.0](https://github.com/adityatelange/hugo-PaperMod/compare/v3.0...v4.0)
- Added `AccessKeys`
- Improve `theme-switch` logic
- Port `Anchored Headings` from [Codex](https://github.com/jakewies/hugo-theme-codex)
- Added social-icons for `Discord, Mastodon, Keybase, Ko-Fi, Kakaotalk, Nuget, Reddit`
- Update `HLJS to v10.2.1`
- Added `Search` feature with fuse.js and options to tweak search & keyboard navigation in search results
- Add `emojify` in Language-Switch
- Load stylesheet resource with wildcard
- Unset line-clamp in Home-Info mode, content can be as long as one wants it to be
- Disable indexing website when not in production
- Social-Icons name can match even when case does not match with set name
- Add option to `disable fingerprinting`
- Add option to `disable highlight.js`
- Retain `anchor link '#'` in URL when clicked on anchored headings
- Add support for `custom taxonomy URLs`
- Add option to hide cover images from list, single but retain in structured-data and share links
- `Extended css` can be directly added to asset bundle, all .css under `assets/css/extended/`
- Do not smooth-scroll when user has preferred to not
- Fix `broken anchor Link` scroll for Table of Contents and non-ASCII chars
- Fix Lang Name hidden when LanguageName was unset
- Fix scroll-bar track on various conditions
- Fix menu items overflow instead of horizontal scroll
- Fix Trailing slash in menu urls
- Fix figure captions added to Table of Contents
- Fix embeded gist colored dark
- Fix wrong load stylesheet and JS on multihost (multilingual)
- Fix Go-To-Top button not shown on code-background in light mode
- Translations added: Bahasa(id), Italian(it), improvements to german(de)
- Miscellaneous improvements, fixes and accessibility enhancements
- Added `AccessKeys`
- Improve `theme-switch` logic
- Port `Anchored Headings` from [Codex](https://github.com/jakewies/hugo-theme-codex)
- Added social-icons for `Discord, Mastodon, Keybase, Ko-Fi, Kakaotalk, Nuget, Reddit`
- Update `HLJS to v10.2.1`
- Added `Search` feature with fuse.js and options to tweak search & keyboard navigation in search results
- Add `emojify` in Language-Switch
- Load stylesheet resource with wildcard
- Unset line-clamp in Home-Info mode, content can be as long as one wants it to be
- Disable indexing website when not in production
- Social-Icons name can match even when case does not match with set name
- Add option to `disable fingerprinting`
- Add option to `disable highlight.js`
- Retain `anchor link '#'` in URL when clicked on anchored headings
- Add support for `custom taxonomy URLs`
- Add option to hide cover images from list, single but retain in structured-data and share links
- `Extended css` can be directly added to asset bundle, all .css under `assets/css/extended/`
- Do not smooth-scroll when user has preferred to not
- Fix `broken anchor Link` scroll for Table of Contents and non-ASCII chars
- Fix Lang Name hidden when LanguageName was unset
- Fix scroll-bar track on various conditions
- Fix menu items overflow instead of horizontal scroll
- Fix Trailing slash in menu urls
- Fix figure captions added to Table of Contents
- Fix embeded gist colored dark
- Fix wrong load stylesheet and JS on multihost (multilingual)
- Fix Go-To-Top button not shown on code-background in light mode
- Translations added: Bahasa(id), Italian(it), improvements to german(de)
- Miscellaneous improvements, fixes and accessibility enhancements
---
@ -69,17 +69,17 @@
[Compare v2.0...v3.0](https://github.com/adityatelange/hugo-PaperMod/compare/v2.0...v3.0)
- enhanced templates a/c to theme for `social-meta`
- add support for `Rich Results`
- add option to customize `NavBar Label`
- i18n: more translations (thanks to contributors)
- add support for `extended_head` and `extended_footer`
- add support for `Right Aligned Text` for multilingual mode
- add support for `responsive cover image`
- add support for `multiple authors`
- add automatic `#hashtag` generator for twitter share with `tags` from a post
- add `Language switch`, an improvement to multilingual feature
- miscellaneous improvements, fixes and accessibility enhancements
- enhanced templates a/c to theme for `social-meta`
- add support for `Rich Results`
- add option to customize `NavBar Label`
- i18n: more translations (thanks to contributors)
- add support for `extended_head` and `extended_footer`
- add support for `Right Aligned Text` for multilingual mode
- add support for `responsive cover image`
- add support for `multiple authors`
- add automatic `#hashtag` generator for twitter share with `tags` from a post
- add `Language switch`, an improvement to multilingual feature
- miscellaneous improvements, fixes and accessibility enhancements
---
@ -87,22 +87,22 @@
[Compare v1.0...v2.0](https://github.com/adityatelange/hugo-PaperMod/compare/v1.0...v2.0)
- added support for `cover image` with captions
- add option to allow `disabling of special 1st post`
- improved `taxonomy` pages
- added option to `open toc` by deafult(for each post)
- theme: `automatic` based on browser theme
- update `HLJS to v10.2.0`
- `ToC`: improvements, fixes (custom implementation)
- Archives: improvements
- added `Menu Location indicator`
- i18n: more translations (thanks to contributors)
- profile-mode: subtitle
- added `theme-toggle` to switch between dark and light
- footer: user-defined copyright
- `favicon` can be set to custom path
- comments can be disabled for a page
- miscellaneous improvements, fixes and accessibility enhancements
- added support for `cover image` with captions
- add option to allow `disabling of special 1st post`
- improved `taxonomy` pages
- added option to `open toc` by deafult(for each post)
- theme: `automatic` based on browser theme
- update `HLJS to v10.2.0`
- `ToC`: improvements, fixes (custom implementation)
- Archives: improvements
- added `Menu Location indicator`
- i18n: more translations (thanks to contributors)
- profile-mode: subtitle
- added `theme-toggle` to switch between dark and light
- footer: user-defined copyright
- `favicon` can be set to custom path
- comments can be disabled for a page
- miscellaneous improvements, fixes and accessibility enhancements
---
@ -110,24 +110,24 @@
[Compare ...v1.0](https://github.com/adityatelange/hugo-PaperMod/compare/4330c8b...v1.0)
- use of `hugo's asset generator with pipelining`
- asset `fingerprinting`, `bundling` and `minification` by default
- seperated `layouts` and `partials` into more readable parts
- separated `css stylesheets` into parts
- added `archive` layout
- added `Home-Info` Mode
- added `Table of content` genration
- added `smooth scroll` between in page tags
- added `Taxonomy pages` (tags, categories)
- added themed `scrollbar`
- added `Scroll-to-Top` button
- added post `Share` buttons
- added `draft` page indicator
- added google siteverification tag vars
- add option to disable post meta
- save `menu scroll position` in browser's storage
- added `Profile-Mode` with buttons
- added `Social Icons`
- updated `HLJS`
- added `multilingual support`
- micellaneous `additions`, `improvements` and `fixes`
- use of `hugo's asset generator with pipelining`
- asset `fingerprinting`, `bundling` and `minification` by default
- seperated `layouts` and `partials` into more readable parts
- separated `css stylesheets` into parts
- added `archive` layout
- added `Home-Info` Mode
- added `Table of content` genration
- added `smooth scroll` between in page tags
- added `Taxonomy pages` (tags, categories)
- added themed `scrollbar`
- added `Scroll-to-Top` button
- added post `Share` buttons
- added `draft` page indicator
- added google siteverification tag vars
- add option to disable post meta
- save `menu scroll position` in browser's storage
- added `Profile-Mode` with buttons
- added `Social Icons`
- updated `HLJS`
- added `multilingual support`
- micellaneous `additions`, `improvements` and `fixes`

172
FAQs.md

@ -1,25 +1,25 @@
## ToC
- [Intro](#intro)
- [Override theme template](#override-theme-template)
- [Enable Social-Metadata and SEO](#enable-social-metadata-and-seo)
- [Failed to find a valid digest in the 'integrity' attribute for resource ... ?](#failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource--)
- [Bundling Custom css with theme's assets](#bundling-custom-css-with-themes-assets)
- [Custom Head / Footer](#custom-head--footer)
- [Add menu to site](#add-menu-to-site)
- [Pin a Post](#pin-a-post)
- [Adding Custom Favicon(s)](#adding-custom-favicons)
- [Centering image in markdown](#centering-image-in-markdown)
- [Using Hugo's Syntax highlighter "chroma"](#using-hugos-syntax-highlighter-chroma)
- [References](#references)
- [Intro](#intro)
- [Override theme template](#override-theme-template)
- [Enable Social-Metadata and SEO](#enable-social-metadata-and-seo)
- [Failed to find a valid digest in the 'integrity' attribute for resource ... ?](#failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource--)
- [Bundling Custom css with theme's assets](#bundling-custom-css-with-themes-assets)
- [Custom Head / Footer](#custom-head--footer)
- [Add menu to site](#add-menu-to-site)
- [Pin a Post](#pin-a-post)
- [Adding Custom Favicon(s)](#adding-custom-favicons)
- [Centering image in markdown](#centering-image-in-markdown)
- [Using Hugo's Syntax highlighter "chroma"](#using-hugos-syntax-highlighter-chroma)
- [References](#references)
---
## Intro
- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.**
- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.**
- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary.
- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary.
---
@ -50,7 +50,7 @@ These include OpenGraph, Twitter Cards and Schema.
```yml
params:
env: production
env: production
```
or set `HUGO_ENV` as "production" in system env-vars
@ -69,21 +69,21 @@ Set the following in `config.yml`
```yml
params:
assets:
disableFingerprinting: true
assets:
disableFingerprinting: true
```
Linked Issues:
- https://stackoverflow.com/questions/65056585/hugo-theme-not-loading
- https://stackoverflow.com/questions/65040931/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource
- https://blog.gerardbeckerleg.com/posts/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource/
- https://stackoverflow.com/questions/65056585/hugo-theme-not-loading
- https://stackoverflow.com/questions/65040931/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource
- https://blog.gerardbeckerleg.com/posts/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource/
---
## Bundling Custom css with theme's assets
- For adding custom css to be bundled inside one minimized css
- For adding custom css to be bundled inside one minimized css
Create folder in yout project directory as
@ -105,7 +105,7 @@ All `css` files inside `assets/css/extended` will be bundled !
Linked Issues:
- [Papermod Theme: How to add custom CSS?](https://discourse.gohugo.io/t/papermod-theme-how-to-add-custom-css/30165)
- [Papermod Theme: How to add custom CSS?](https://discourse.gohugo.io/t/papermod-theme-how-to-add-custom-css/30165)
---
@ -142,19 +142,19 @@ To do so, add a `menu` section to your site's `config.yml`:
```yml
menu:
main:
- identifier: categories
name: categories
url: /categories/
weight: 10
- identifier: tags
name: tags
url: /tags/
weight: 20
- identifier: example
name: example.org
url: https://example.org
weight: 30
main:
- identifier: categories
name: categories
url: /categories/
weight: 10
- identifier: tags
name: tags
url: /tags/
weight: 20
- identifier: example
name: example.org
url: https://example.org
weight: 30
```
`name` controls what will be displayed for the menu entry.
@ -177,7 +177,6 @@ title: "My Important post"
date: 2020-09-15T11:30:03+00:00
weight: 1
---
```
```yml
@ -186,7 +185,6 @@ title: "My 2nd Important post"
date: 2020-09-15T11:30:03+00:00
weight: 2
---
```
---
@ -196,43 +194,43 @@ weight: 2
We support the following paths under `/static` directory
and can be added accordingly.
- `favicon.ico`
- `favicon-16x16.png`
- `favicon-32x32.png`
- `apple-touch-icon.png`
- `safari-pinned-tab.svg`
- `favicon.ico`
- `favicon-16x16.png`
- `favicon-32x32.png`
- `apple-touch-icon.png`
- `safari-pinned-tab.svg`
1. Favicon(s) can be generated by [Favicon.io](https://favicon.io)
and can be simply put in `/static` folder.
and can be simply put in `/static` folder.
2. Other way is to add favicon(s) NOT located in `/static` folder.
In site config add the following:
In site config add the following:
```
params:
assets:
favicon: "<link / absolute url>"
favicon16x16: "<link / absolute url>"
favicon32x32: "<link / absolute url>"
apple_touch_icon: "<link / absolute url>"
safari_pinned_tab: "<link / absolute url>"
```
```
params:
assets:
favicon: "<link / absolute url>"
favicon16x16: "<link / absolute url>"
favicon32x32: "<link / absolute url>"
apple_touch_icon: "<link / absolute url>"
safari_pinned_tab: "<link / absolute url>"
```
- `absolute url` means direct links to external resource: ex. https://web.site/someimage.png
- `absolute url` means direct links to external resource: ex. https://web.site/someimage.png
example:
example:
```
params:
assets:
favicon: "/favicon.ico"
favicon16x16: "/favicon-16x16.png"
favicon32x32: "/favicon-32x32.png"
apple_touch_icon: "/apple-touch-icon.png"
safari_pinned_tab: "/safari-pinned-tab.svg"
```
```
params:
assets:
favicon: "/favicon.ico"
favicon16x16: "/favicon-16x16.png"
favicon32x32: "/favicon-32x32.png"
apple_touch_icon: "/apple-touch-icon.png"
safari_pinned_tab: "/safari-pinned-tab.svg"
```
---
@ -260,38 +258,38 @@ ex.
1. Disable Highlight.js in site `config.yml`
```yml
params:
assets:
disableHLJS: true
```
```yml
params:
assets:
disableHLJS: true
```
2. Set hugo's markdown styling in site `config.yml`
```yml
markup:
highlight:
# anchorLineNos: true
codeFences: true
guessSyntax: true
lineNos: true
# noClasses: false
style: monokai
```
```yml
markup:
highlight:
# anchorLineNos: true
codeFences: true
guessSyntax: true
lineNos: true
# noClasses: false
style: monokai
```
3. If you want `lineNos: true`, the background won't be proper.
This will only work with `noClasses: false` or `pygmentsUseClasses: true`.
Read [Generate Syntax Highlighter CSS](https://gohugo.io/content-management/syntax-highlighting/#generate-syntax-highlighter-css)
Add the following to `assets/css/extended/custom.css`
Add the following to `assets/css/extended/custom.css`
```css
.chroma {
background-color: unset;
}
```
```css
.chroma {
background-color: unset;
}
```
More Info : [Configure Markup - Highlight](https://gohugo.io/getting-started/configuration-markup#highlight)
More Info : [Configure Markup - Highlight](https://gohugo.io/getting-started/configuration-markup#highlight)
---
@ -315,4 +313,4 @@ xhr.open("GET", "https://example.com/index.json");
## References
- [Override a Hugo theme](https://zwbetz.com/override-a-hugo-theme/)
- [Override a Hugo theme](https://zwbetz.com/override-a-hugo-theme/)

1
Features.md

@ -206,6 +206,7 @@ layout: "search" # is necessary
# url: "/archive"
# description: "Description for Search"
summary: "search"
placeholder: "placeholder text in search input box"
---
```

14
Home.md

@ -13,16 +13,16 @@ Demo Site : https://adityatelange.github.io/hugo-PaperMod/
## Quick Links
- ### [Install / Update](./Installation)
- ### [Install / Update](./Installation)
- ### [Features](./Features)
- ### [Features](./Features)
- ### [Icons](./Icons)
- ### [Icons](./Icons)
- ### [FAQs](./FAQs)
- ### [FAQs](./FAQs)
- ### [Variables](./Variables)
- ### [Variables](./Variables)
- ### [Translations](./Translations)
- ### [Translations](./Translations)
- ### [ChangeLog](./ChangeLog)
- ### [ChangeLog](./ChangeLog)

139
Icons.md

@ -1,68 +1,71 @@
## ToC
- [Social Icons](#social-icons)
- [Share Icons](#share-icons)
- [Social Icons](#social-icons)
- [Share Icons](#share-icons)
## Social Icons
| No. | Name | Platform Link |
| --- | --------------- | ------------------------------- |
| 1 | `123rf` | 123rf.com |
| 2 | `adobestock` | stock.adobe.com |
| 3 | `behance` | behance.net |
| 4 | `buymeacoffee` | buymeacoffee.com |
| 5 | `codepen` | codepen.io |
| 6 | `cryptohack` | cryptohack.org |
| 7 | `ctftime` | ctftime.org |
| 8 | `dev` | dev.to |
| 9 | `discogs` | discogs.com |
| 10 | `discord` | discord.com |
| 11 | `dreamstime` | dreamstime.com |
| 12 | `dribbble` | dribbble.com |
| 13 | `email` | - |
| 14 | `facebook` | facebook.com |
| 15 | `flickr` | flickr.com |
| 16 | `freepik` | freepik.com |
| 17 | `gitea` | gitea.io |
| 18 | `github` | github.com |
| 19 | `gitlab` | gitlab.com |
| 20 | `goodreads` | goodreads.com |
| 21 | `hackerone` | hackerone.com |
| 22 | `hackerrank` | hackerrank.com |
| 23 | `hackthebox` | hackthebox.eu |
| 24 | `instagram` | instagram.com |
| 25 | `itchio` | itch.io |
| 26 | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 27 | `keybase` | keybase.io |
| 28 | `kofi` | ko-fi.com |
| 29 | `lastfm` | last.fm |
| 30 | `liberapay` | liberapay.com |
| 31 | `linkedin` | linkedin.com |
| 32 | `mastodon` | mastodon.social |
| 33 | `matrix` | matrix.org |
| 34 | `medium` | medium.com |
| 35 | `mixcloud` | mixcloud.com |
| 36 | `nuget` | nuget.org |
| 37 | `paypal` | paypal.com |
| 38 | `qq` | qq.com |
| 39 | `reddit` | reddit.com |
| 40 | `rss` | - |
| 41 | `serverfault` | serverfault.com |
| 42 | `soundcloud` | soundcloud.com |
| 43 | `shutterstock` | shutterstock.com |
| 44 | `slack` | slack.com |
| 45 | `snapchat` | snapchat.com/add |
| 46 | `sourcerer` | sourcerer.io |
| 47 | `spotify` | spotify.com |
| 48 | `stackoverflow` | stackoverflow.com |
| 49 | `steam` | steampowered.com |
| 50 | `telegram` | telegram.org |
| 51 | `twitch` | twitch.tv |
| 52 | `twitter` | twitter.com |
| 53 | `unsplash` | unsplash.com |
| 54 | `xda` | xda-developers.com |
| 55 | `youtube` | youtube.com |
| 56 | `other` | - |
| Name | Platform Link |
| --------------- | ------------------------------- |
| `123rf` | 123rf.com |
| `adobestock` | stock.adobe.com |
| `behance` | behance.net |
| `buymeacoffee` | buymeacoffee.com |
| `codepen` | codepen.io |
| `cryptohack` | cryptohack.org |
| `ctftime` | ctftime.org |
| `dev` | dev.to |
| `discogs` | discogs.com |
| `discord` | discord.com |
| `dreamstime` | dreamstime.com |
| `dribbble` | dribbble.com |
| `email` | - |
| `facebook` | facebook.com |
| `flickr` | flickr.com |
| `freepik` | freepik.com |
| `gitea` | gitea.io |
| `github` | github.com |
| `gitlab` | gitlab.com |
| `goodreads` | goodreads.com |
| `googlescholar` | scholar.google.com |
| `hackerone` | hackerone.com |
| `hackerrank` | hackerrank.com |
| `hackthebox` | hackthebox.eu |
| `instagram` | instagram.com |
| `itchio` | itch.io |
| `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| `keybase` | keybase.io |
| `kofi` | ko-fi.com |
| `lastfm` | last.fm |
| `liberapay` | liberapay.com |
| `linkedin` | linkedin.com |
| `mastodon` | mastodon.social |
| `matrix` | matrix.org |
| `medium` | medium.com |
| `mixcloud` | mixcloud.com |
| `nuget` | nuget.org |
| `paypal` | paypal.com |
| `qq` | qq.com |
| `reddit` | reddit.com |
| `researchgate` | researchgate.net |
| `rss` | - |
| `serverfault` | serverfault.com |
| `soundcloud` | soundcloud.com |
| `shutterstock` | shutterstock.com |
| `slack` | slack.com |
| `snapchat` | snapchat.com/add |
| `sourcerer` | sourcerer.io |
| `spotify` | spotify.com |
| `stackoverflow` | stackoverflow.com |
| `steam` | steampowered.com |
| `telegram` | telegram.org |
| `twitch` | twitch.tv |
| `twitter` | twitter.com |
| `unsplash` | unsplash.com |
| `xda` | xda-developers.com |
| `ycombinator` | ycombinator.com |
| `youtube` | youtube.com |
| `other` | - |
Usage :
@ -78,14 +81,14 @@ socialIcons:
## Share Icons
| No. | Platform |
| --- | --------------------------------------------------------------- |
| 1 | `twitter` (also generates hash tags from tags linked with post) |
| 2 | `linkedin` |
| 3 | `reddit` |
| 4 | `facebook` |
| 5 | `whatsapp` |
| 6 | `telegram` |
| No. | Platform |
| --------------------------------------------------------------- | -------- |
| `twitter` (also generates hash tags from tags linked with post) |
| `linkedin` |
| `reddit` |
| `facebook` |
| `whatsapp` |
| `telegram` |
Usage:

246
Installation.md

@ -1,19 +1,19 @@
## ToC
- [Guide](#guide)
- [Method 1](#method-1)
- [Method 2](#method-2)
- [Method 3](#method-3)
- [Finally ...](#finally-)
- [Sample config.yml](#sample-configyml)
- [Sample Page.md](#sample-pagemd)
- [Guide](#guide)
- [Method 1](#method-1)
- [Method 2](#method-2)
- [Method 3](#method-3)
- [Finally ...](#finally-)
- [Sample config.yml](#sample-configyml)
- [Sample Page.md](#sample-pagemd)
---
## Intro
- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.**
- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary.
- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.**
- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary.
---
@ -69,12 +69,12 @@ Or you can Download as Zip from Github Page and extract in your themes directory
Direct Links:
- [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)
- [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip)
- [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip)
- [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.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)
- [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip)
- [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip)
- [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip)
### Finally ...
@ -88,17 +88,17 @@ theme: "PaperMod"
## Quick Links
- ### [Features](./Features)
- ### [Features](./Features)
- ### [Icons](./Icons)
- ### [Icons](./Icons)
- ### [FAQs](./FAQs)
- ### [FAQs](./FAQs)
- ### [Variables](./Variables)
- ### [Variables](./Variables)
- ### [Translations](./Translations)
- ### [Translations](./Translations)
- ### [ChangeLog](./ChangeLog)
- ### [ChangeLog](./ChangeLog)
---
@ -122,118 +122,118 @@ buildExpired: false
googleAnalytics: UA-123-45
minify:
disableXML: true
minifyOutput: true
disableXML: true
minifyOutput: true
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
description: "ExampleSite description"
keywords: [Blog, Portfolio, PaperMod]
author: Me
# author: ["Me", "You"] # multiple authors
images: ["<link or path of image for opengraph, twitter-cards>"]
DateFormat: "January 2, 2006"
defaultTheme: auto # dark, light
disableThemeToggle: false
ShowReadingTime: true
ShowShareButtons: true
ShowPostNavLinks: true
ShowBreadCrumbs: true
ShowCodeCopyButtons: false
disableSpecial1stPost: false
disableScrollToTop: false
comments: false
hidemeta: false
hideSummary: false
showtoc: false
tocopen: false
assets:
# disableHLJS: true # to disable highlight.js
# disableFingerprinting: true
favicon: "<link / abs url>"
favicon16x16: "<link / abs url>"
favicon32x32: "<link / abs url>"
apple_touch_icon: "<link / abs url>"
safari_pinned_tab: "<link / abs url>"
label:
text: "Home"
icon: /apple-touch-icon.png
iconHeight: 35
# profile-mode
profileMode:
enabled: false # needs to be explicitly set
title: ExampleSite
description: "ExampleSite description"
keywords: [Blog, Portfolio, PaperMod]
author: Me
# author: ["Me", "You"] # multiple authors
images: ["<link or path of image for opengraph, twitter-cards>"]
DateFormat: "January 2, 2006"
defaultTheme: auto # dark, light
disableThemeToggle: false
subtitle: "This is subtitle"
imageUrl: "<img location>"
imageWidth: 120
imageHeight: 120
imageTitle: my image
buttons:
- name: Posts
url: posts
- name: Tags
url: tags
ShowReadingTime: true
ShowShareButtons: true
ShowPostNavLinks: true
ShowBreadCrumbs: true
ShowCodeCopyButtons: false
disableSpecial1stPost: false
disableScrollToTop: false
comments: false
hidemeta: false
hideSummary: false
showtoc: false
tocopen: false
# home-info mode
homeInfoParams:
Title: "Hi there \U0001F44B"
Content: Welcome to my blog
assets:
# disableHLJS: true # to disable highlight.js
# disableFingerprinting: true
favicon: "<link / abs url>"
favicon16x16: "<link / abs url>"
favicon32x32: "<link / abs url>"
apple_touch_icon: "<link / abs url>"
safari_pinned_tab: "<link / abs url>"
socialIcons:
- name: twitter
url: "https://twitter.com/"
- name: stackoverflow
url: "https://stackoverflow.com"
- name: github
url: "https://github.com/"
label:
text: "Home"
icon: /apple-touch-icon.png
iconHeight: 35
analytics:
google:
SiteVerificationTag: "XYZabc"
bing:
SiteVerificationTag: "XYZabc"
yandex:
SiteVerificationTag: "XYZabc"
# profile-mode
profileMode:
enabled: false # needs to be explicitly set
title: ExampleSite
subtitle: "This is subtitle"
imageUrl: "<img location>"
imageWidth: 120
imageHeight: 120
imageTitle: my image
buttons:
- name: Posts
url: posts
- name: Tags
url: tags
cover:
hidden: true # hide everywhere but not in structured data
hiddenInList: true # hide on list pages and home
hiddenInSingle: true # hide on single page
# home-info mode
homeInfoParams:
Title: "Hi there \U0001F44B"
Content: Welcome to my blog
editPost:
URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link
socialIcons:
- name: twitter
url: "https://twitter.com/"
- name: stackoverflow
url: "https://stackoverflow.com"
- name: github
url: "https://github.com/"
analytics:
google:
SiteVerificationTag: "XYZabc"
bing:
SiteVerificationTag: "XYZabc"
yandex:
SiteVerificationTag: "XYZabc"
cover:
hidden: true # hide everywhere but not in structured data
hiddenInList: true # hide on list pages and home
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
# https://fusejs.io/api/options.html
fuseOpts:
isCaseSensitive: false
shouldSort: true
location: 0
distance: 1000
threshold: 0.4
minMatchCharLength: 0
keys: ["title", "permalink", "summary", "content"]
# for search
# https://fusejs.io/api/options.html
fuseOpts:
isCaseSensitive: false
shouldSort: true
location: 0
distance: 1000
threshold: 0.4
minMatchCharLength: 0
keys: ["title", "permalink", "summary", "content"]
menu:
main:
- identifier: categories
name: categories
url: /categories/
weight: 10
- identifier: tags
name: tags
url: /tags/
weight: 20
- identifier: example
name: example.org
url: https://example.org
weight: 30
main:
- identifier: categories
name: categories
url: /categories/
weight: 10
- identifier: tags
name: tags
url: /tags/
weight: 20
- identifier: example
name: example.org
url: https://example.org
weight: 30
# Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma
# pygmentsUseClasses: true
# markup:

62
Translations.md

@ -1,34 +1,38 @@
## Languages Supported
| Name | ISO Code | Available Translations |
| ---------- | -------- | ------------------------------------------------------------------------------------------- |
| Arabic | ar | prev_page, next_page, read_time, toc, translations, home |
| Bulgarian | bg | prev_page, next_page, read_time, toc, translations |
| Bengali | bn | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Catalan | ca | prev_page, next_page, read_time, toc, translations, home |
| German | de | prev_page, next_page, read_time, toc, translations, edit_post |
| English | en | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Esperanto | eo | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Spanish | es | prev_page, next_page, read_time, toc, translations |
| Farsi | fa | prev_page, next_page, read_time, toc, translations |
| French | fr | prev_page, next_page |
| Hebrew | he | prev_page, next_page, read_time, toc, translations, home |
| Hindi | hi | prev_page, next_page, read_time, toc, translations |
| Hungarian | hu | prev_page, next_page, read_time, toc, translations |
| Indonesian | id | prev_page, next_page, read_time, toc, translations |
| Italian | it | prev_page, next_page, read_time, toc, translations |
| Japanese | ja | prev_page, next_page, read_time, toc, translations |
| Korean | ko | prev_page, next_page |
| Mongolian | mn | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Dutch | nl | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Polish | pl | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Portuguese | pt | prev_page, next_page, read_time, toc, translations |
| Russian | ru | prev_page, next_page, read_time, toc, translations |
| Turkish | tr | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Ukrainian | uk | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Uzbek | uz | prev_page, next_page, read_time, toc, translations, home |
| Vietnamese | vi | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Chinese | zh | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Name | ISO Code | Available Translations |
| ---------------------------- | -------- | ------------------------------------------------------------------------------------------- |
| Arabic | ar | prev_page, next_page, read_time, toc, translations, home |
| Bulgarian | bg | prev_page, next_page, read_time, toc, translations |
| Bengali | bn | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Catalan | ca | prev_page, next_page, read_time, toc, translations, home |
| Northern and Central Kurdish | ckb | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Danish | da | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| German | de | prev_page, next_page, read_time, toc, translations, edit_post |
| English | en | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Esperanto | eo | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Spanish | es | prev_page, next_page, read_time, toc, translations |
| Farsi | fa | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| French | fr | prev_page, next_page |
| Hebrew | he | prev_page, next_page, read_time, toc, translations, home |
| Hindi | hi | prev_page, next_page, read_time, toc, translations |
| Hungarian | hu | prev_page, next_page, read_time, toc, translations |
| Indonesian | id | prev_page, next_page, read_time, toc, translations |
| Italian | it | prev_page, next_page, read_time, toc, translations |
| Japanese | ja | prev_page, next_page, read_time, toc, translations, code_copy, code_copied |
| Korean | ko | prev_page, next_page |
| Kurdish | ku | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Mongolian | mn | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Dutch | nl | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Polish | pl | prev_page, next_page, read_time, toc, translations, home, edit_post, code_copy, code_copied |
| Portuguese | pt | prev_page, next_page, read_time, toc, translations |
| Russian | ru | prev_page, next_page, read_time, toc, translations |
| Turkish | tr | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Ukrainian | uk | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Uzbek | uz | prev_page, next_page, read_time, toc, translations, home |
| Vietnamese | vi | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Taiwanese Chinese | zh-tw | rev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
| Chinese | zh | prev_page, next_page, read_time, toc, translations, home, code_copy, code_copied |
## Want to add your Language ?

89
Variables.md

@ -1,49 +1,52 @@
## ToC
- [Site Variables](#site-variables)
- [Page Variables](#page-variables)
- [Site Variables](#site-variables)
- [Page Variables](#page-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` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| `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/) |
| `languageAltTitle` | string | "English" | Alternate title in Multilingual Mode |
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post |
| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button |
| `ShowFullTextinRSS` | boolean | true \| false | To show Content in RSS feed |
| `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 |
| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button |
| `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings |
| `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 |
| `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| `tocopen` | boolean | true \| false | To keep open ToC by default on page load |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| `comments` | boolean | true \| false | To show/hide comments |
| `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics |
| `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing |
| `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex |
| `schema` | - | - | [Details](#schema) |
| `fuseOpts` | - | - | [Details](#fuseOpts) |
| `socialIcons` | - | - | [Details](#socialIcons) |
| `label` | - | - | [Details](#label) |
| `assets` | - | - | [Details](#assets) |
| `cover` | - | - | [Details](#cover) |
| `profileMode` | - | - | [Details](#profilemode) |
| `editPost` | - | - | [Details](#editPost) |
| 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 |
| `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/) |
| `languageAltTitle` | string | "English" | Alternate title in Multilingual Mode |
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post |
| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button |
| `ShowFullTextinRSS` | boolean | true \| false | To show Content in RSS feed |
| `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 |
| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button |
| `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings |
| `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 |
| `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| `tocopen` | boolean | true \| false | To keep open ToC by default on page load |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page |
| `comments` | boolean | true \| false | To show/hide comments |
| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page |
| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname |
| `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics |
| `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing |
| `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex |
| `schema` | - | - | [Details](#schema) |
| `fuseOpts` | - | - | [Details](#fuseOpts) |
| `socialIcons` | - | - | [Details](#socialIcons) |
| `label` | - | - | [Details](#label) |
| `assets` | - | - | [Details](#assets) |
| `cover` | - | - | [Details](#cover) |
| `profileMode` | - | - | [Details](#profilemode) |
| `editPost` | - | - | [Details](#editPost) |
### Site Variables
@ -156,18 +159,24 @@ editPost:
| `comments` | boolean | true \| false | To show/hide comments |
| `description` | string | 'description text' | Show Post Description under Title |
| `canonicalURL` | string | "https://canonical.url/to/page" | To add canonical URL to posts |
| `ShowCanonicalLink` | boolean | true \| false | To show canonical URL's hostname |
| `CanonicalLinkText` | string | 'Originally published at' | To show text before canonical URL's hostname |
| `disableShare` | boolean | true \| false | To hide/show share icons under a page |
| `disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| `disableAnchoredHeadings` | boolean | true \| false | To disable Anchored Headings |
| `searchHidden` | boolean | true \| false | Hide page from search |
| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages |
| `hideFooter` | boolean | true \| false | To Hide Footer Text om the end of page |
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| `ShowCodeCopyButtons` | boolean | true \| false | To show/hide Code Copy button |
| `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 ` | boolean | true \| false | To hide on current single page |
| `cover.responsiveImages` | boolean | true \| false | To enable/disable generation of responsive cover images |
| `cover.hidden` | boolean | true \| false | To hide on current single page |
| `weight ` | integer | 5 | To set page order or to pin a post to Top of list |
| `ShareButtons` | list | ["linkedin", "twitter"] | To customize which share buttons to be enabled on page |