mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2023-12-21 10:22:58 +01:00
update wiki
Aditya Telange
parent
9e0977efcb
commit
717cc06d64
28
FAQs.md
28
FAQs.md
@ -4,7 +4,6 @@
|
|||||||
- [Override theme template](#override-theme-template)
|
- [Override theme template](#override-theme-template)
|
||||||
- [Enable Social-Metadata and SEO](#enable-social-metadata-and-seo)
|
- [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--)
|
- [Failed to find a valid digest in the 'integrity' attribute for resource ... ?](#failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource--)
|
||||||
- [Archive Page](#archive-page)
|
|
||||||
- [Bundling Custom css with theme's assets](#bundling-custom-css-with-themes-assets)
|
- [Bundling Custom css with theme's assets](#bundling-custom-css-with-themes-assets)
|
||||||
- [Custom Head / Footer](#custom-head--footer)
|
- [Custom Head / Footer](#custom-head--footer)
|
||||||
- [Add menu to site](#add-menu-to-site)
|
- [Add menu to site](#add-menu-to-site)
|
||||||
@ -82,33 +81,6 @@ Linked Issues:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Archive Page
|
|
||||||
|
|
||||||
```shell
|
|
||||||
.
|
|
||||||
├── config.yml
|
|
||||||
├── content/
|
|
||||||
│ ├── archives.md <--- Create archive.md here
|
|
||||||
│ └── posts/
|
|
||||||
├── static/
|
|
||||||
└── themes/
|
|
||||||
└── hugo-PaperMod/
|
|
||||||
```
|
|
||||||
|
|
||||||
and add the following to it
|
|
||||||
|
|
||||||
```yml
|
|
||||||
---
|
|
||||||
title: "Archive"
|
|
||||||
layout: "archives"
|
|
||||||
url: "/archives/"
|
|
||||||
summary: archives
|
|
||||||
---
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Bundling Custom css with theme's assets
|
## 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
|
||||||
|
|||||||
64
Features.md
64
Features.md
@ -13,6 +13,8 @@
|
|||||||
- [Share Buttons on post](#share-buttons-on-post)
|
- [Share Buttons on post](#share-buttons-on-post)
|
||||||
- [Show post reading time](#show-post-reading-time)
|
- [Show post reading time](#show-post-reading-time)
|
||||||
- [Show Table of Contents (Toc) on blog post](#show-table-of-contents-toc-on-blog-post)
|
- [Show Table of Contents (Toc) on blog post](#show-table-of-contents-toc-on-blog-post)
|
||||||
|
- [BreadCrumb Navigation](#breadcrumb-navigation)
|
||||||
|
- [Other Posts suggestion below a post](#other-posts-suggestion-below-a-post)
|
||||||
- [Multiple Authors](#multiple-authors)
|
- [Multiple Authors](#multiple-authors)
|
||||||
- [Comments](#comments)
|
- [Comments](#comments)
|
||||||
- [AccessKeys](#accesskeys)
|
- [AccessKeys](#accesskeys)
|
||||||
@ -88,13 +90,25 @@ You can refer following table for better understanding...
|
|||||||
|
|
||||||
Create a page with `archive.md` in `content` directory with following content
|
Create a page with `archive.md` in `content` directory with following content
|
||||||
|
|
||||||
|
```shell
|
||||||
|
.
|
||||||
|
├── config.yml
|
||||||
|
├── content/
|
||||||
|
│ ├── archives.md <--- Create archive.md here
|
||||||
|
│ └── posts/
|
||||||
|
├── static/
|
||||||
|
└── themes/
|
||||||
|
└── PaperMod/
|
||||||
|
```
|
||||||
|
|
||||||
|
and add the following to it
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
---
|
---
|
||||||
title: "Archive" # in any language you want
|
title: "Archive"
|
||||||
layout: "archives" # is necessary
|
layout: "archives"
|
||||||
url: "/archive"
|
url: "/archives/"
|
||||||
summary: "archive"
|
summary: archives
|
||||||
# description: "Description for Archive"
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -170,6 +184,8 @@ params:
|
|||||||
|
|
||||||
### Search
|
### Search
|
||||||
|
|
||||||
|
PaperMod uses [Fuse.js Basic](https://fusejs.io/getting-started/different-builds.html#explanation-of-different-builds) for seach functionality
|
||||||
|
|
||||||
Add the following to site config, `config.yml`
|
Add the following to site config, `config.yml`
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
@ -193,6 +209,15 @@ summary: "search"
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
To hide a particular page from being searched, add it in post's fron't matter
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
searchHidden: true
|
||||||
|
```
|
||||||
|
|
||||||
|
ex: [search.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md)
|
||||||
|
|
||||||
For Multilingual use `search.<lang>.md` ex. `search.es.md`.
|
For Multilingual use `search.<lang>.md` ex. `search.es.md`.
|
||||||
|
|
||||||
**Note:** Search will work only on current language, user is currently on !
|
**Note:** Search will work only on current language, user is currently on !
|
||||||
@ -213,8 +238,6 @@ params:
|
|||||||
keys: ["title", "permalink", "summary", "content"]
|
keys: ["title", "permalink", "summary", "content"]
|
||||||
```
|
```
|
||||||
|
|
||||||
ex: [search.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Draft Page indication
|
### Draft Page indication
|
||||||
@ -301,6 +324,33 @@ TocOpen: true
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### BreadCrumb Navigation
|
||||||
|
|
||||||
|
Adds BreadCrumb Navigation above Post's Title to show subsections and Navigation to Home
|
||||||
|
|
||||||
|
```yml
|
||||||
|
params:
|
||||||
|
ShowBreadCrumbs: true
|
||||||
|
```
|
||||||
|
|
||||||
|
Can be diabled for particular page's front-matter
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
ShowBreadCrumbs: false
|
||||||
|
---
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Other Posts suggestion below a post
|
||||||
|
|
||||||
|
Adds a Previous / Next post suggestion under a single post
|
||||||
|
|
||||||
|
```yml
|
||||||
|
params:
|
||||||
|
ShowPostNavLinks: true
|
||||||
|
```
|
||||||
|
|
||||||
### Multiple Authors
|
### Multiple Authors
|
||||||
|
|
||||||
To Use multiple authors for a post, in post-variables:
|
To Use multiple authors for a post, in post-variables:
|
||||||
|
|||||||
6
Home.md
6
Home.md
@ -15,7 +15,7 @@ Demo Site : https://adityatelange.github.io/hugo-PaperMod/
|
|||||||
|
|
||||||
## Quick Links
|
## Quick Links
|
||||||
|
|
||||||
- ### [Installation](./Installation)
|
- ### [Install / Update](./Installation)
|
||||||
|
|
||||||
- ### [Features](./Features)
|
- ### [Features](./Features)
|
||||||
|
|
||||||
@ -24,3 +24,7 @@ Demo Site : https://adityatelange.github.io/hugo-PaperMod/
|
|||||||
- ### [FAQs](./FAQs)
|
- ### [FAQs](./FAQs)
|
||||||
|
|
||||||
- ### [Variables](./Variables)
|
- ### [Variables](./Variables)
|
||||||
|
|
||||||
|
- ### [Translations](./Translations)
|
||||||
|
|
||||||
|
- ### [ChangeLog](./ChangeLog)
|
||||||
|
|||||||
@ -73,8 +73,6 @@ theme: "PaperMod"
|
|||||||
|
|
||||||
## Quick Links
|
## Quick Links
|
||||||
|
|
||||||
- ### [Installation](./Installation)
|
|
||||||
|
|
||||||
- ### [Features](./Features)
|
- ### [Features](./Features)
|
||||||
|
|
||||||
- ### [Icons](./Icons)
|
- ### [Icons](./Icons)
|
||||||
@ -83,6 +81,10 @@ theme: "PaperMod"
|
|||||||
|
|
||||||
- ### [Variables](./Variables)
|
- ### [Variables](./Variables)
|
||||||
|
|
||||||
|
- ### [Translations](./Translations)
|
||||||
|
|
||||||
|
- ### [ChangeLog](./ChangeLog)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Sample `config.yml`
|
## Sample `config.yml`
|
||||||
@ -234,6 +236,7 @@ description: "Desc Text."
|
|||||||
disableHLJS: true # to disable highlightjs
|
disableHLJS: true # to disable highlightjs
|
||||||
disableShare: false
|
disableShare: false
|
||||||
disableHLJS: false
|
disableHLJS: false
|
||||||
|
searchHidden: true
|
||||||
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
|
||||||
@ -244,4 +247,10 @@ cover:
|
|||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can use it by creating `archetypes/post.md`
|
||||||
|
|
||||||
|
```shell
|
||||||
|
hugo new --kind post <name>
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
83
Variables.md
83
Variables.md
@ -25,12 +25,12 @@
|
|||||||
| ShowPostNavLinks | boolean | true \| false | Show Previous and Next Posts below a Post |
|
| ShowPostNavLinks | boolean | true \| false | Show Previous and Next Posts below a Post |
|
||||||
| ShowBreadCrumbs | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
|
| ShowBreadCrumbs | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
|
||||||
| comments | boolean | true \| false | To show/hide comments |
|
| comments | boolean | true \| false | To show/hide comments |
|
||||||
| fuseOpts | | | |
|
| analytics.google.SiteVerificationTag | string | "XYZabc" | Site Verification Tag for Google Analytics |
|
||||||
| socialIcons | | | |
|
| analytics.bing.SiteVerificationTag | string | "XYZabc" | Site Verification Tag for Bing |
|
||||||
| analytics.google.SiteVerificationTag | string | "XYZabc" | |
|
| analytics.yandex.SiteVerificationTag | string | "XYZabc" | Site Verification Tag for Yandex |
|
||||||
| analytics.bing.SiteVerificationTag | string | "XYZabc" | |
|
|
||||||
| analytics.yandex.SiteVerificationTag | string | "XYZabc" | |
|
|
||||||
| | | | |
|
| | | | |
|
||||||
|
| fuseOpts | - | - | [Details](#fuseOpts) |
|
||||||
|
| socialIcons | - | - | [Details](#socialIcons) |
|
||||||
| label | - | - | [Details](#label) |
|
| label | - | - | [Details](#label) |
|
||||||
| assets | - | - | [Details](#assets) |
|
| assets | - | - | [Details](#assets) |
|
||||||
| cover | - | - | [Details](#cover) |
|
| cover | - | - | [Details](#cover) |
|
||||||
@ -46,23 +46,23 @@
|
|||||||
|
|
||||||
#### profileMode
|
#### profileMode
|
||||||
|
|
||||||
| name | type | example | Description |
|
| name | type | example | Description |
|
||||||
| ----------------------- | ---- | ------- | ----------- |
|
| ----------------------- | ------- | ---------------------------------------------- | ----------- |
|
||||||
| profileMode.enabled | | | |
|
| profileMode.enabled | boolean | true \| false | |
|
||||||
| profileMode.title | | | |
|
| profileMode.title | string | "Title" | |
|
||||||
| profileMode.imageUrl | | | |
|
| profileMode.imageUrl | string | "image.png" \| "https://example.com/image.jpg" | |
|
||||||
| profileMode.imageWidth | | | |
|
| profileMode.imageWidth | string | "" | |
|
||||||
| profileMode.imageHeight | | | |
|
| profileMode.imageHeight | string | "" | |
|
||||||
| profileMode.imageTitle | | | |
|
| profileMode.imageTitle | string | "This image is a picture of .." | |
|
||||||
| profileMode.buttons | | | |
|
| profileMode.buttons | - | - | |
|
||||||
|
|
||||||
#### assets
|
#### assets
|
||||||
|
|
||||||
| name | type | example | Description |
|
| name | type | example | Description |
|
||||||
| ---------------------------- | ------ | ---------- | -------------------------------------------- |
|
| ---------------------------- | ------- | ---------- | -------------------------------------------- |
|
||||||
| assets.favicon | string | 'icon.ico' | To set favicon, can be path or external link |
|
| assets.favicon | string | 'icon.ico' | To set favicon, can be path or external link |
|
||||||
| assets.disableHLJS | | | |
|
| assets.disableHLJS | boolean | | |
|
||||||
| assets.disableFingerprinting | | | |
|
| assets.disableFingerprinting | boolean | | |
|
||||||
|
|
||||||
#### cover
|
#### cover
|
||||||
|
|
||||||
@ -70,9 +70,43 @@
|
|||||||
| ---------------------- | ------- | ------------- | ------------------------------------------------------- |
|
| ---------------------- | ------- | ------------- | ------------------------------------------------------- |
|
||||||
| cover.linkFullImages | boolean | true \| false | To open full size cover images on click on cover |
|
| 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.responsiveImages | boolean | true \| false | To enable/disable generation of responsive cover images |
|
||||||
| cover.hidden | | | |
|
| cover.hidden | boolean | true \| fals | |
|
||||||
| cover.hiddenInList | | | |
|
| cover.hiddenInList | boolean | true \| fals | |
|
||||||
| cover.hiddenInSingle | | | |
|
| cover.hiddenInSingle | boolean | true \| fals | |
|
||||||
|
|
||||||
|
#### fuseOpts
|
||||||
|
|
||||||
|
```yml
|
||||||
|
fuseOpts:
|
||||||
|
isCaseSensitive: false
|
||||||
|
shouldSort: true
|
||||||
|
location: 0
|
||||||
|
distance: 1000
|
||||||
|
threshold: 0.4
|
||||||
|
minMatchCharLength: 0
|
||||||
|
keys: ["title", "permalink", "summary", "content"] ## can be less but not more than shown in list
|
||||||
|
```
|
||||||
|
|
||||||
|
#### socialIcons
|
||||||
|
|
||||||
|
```yml
|
||||||
|
socialIcons:
|
||||||
|
- name: "<platform>"
|
||||||
|
url: "<link>"
|
||||||
|
- name: "<platform 2>"
|
||||||
|
url: "<link2>"
|
||||||
|
```
|
||||||
|
|
||||||
|
####
|
||||||
|
|
||||||
|
```yml
|
||||||
|
profileMode:
|
||||||
|
buttons:
|
||||||
|
- name: Archive
|
||||||
|
url: "/archive"
|
||||||
|
- name: Github
|
||||||
|
url: "https://github.com/"
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -86,13 +120,14 @@
|
|||||||
| comments | boolean | true \| false | To show/hide comments |
|
| comments | boolean | true \| false | To show/hide comments |
|
||||||
| description | string | 'description text' | Show Post Description under Title |
|
| description | string | 'description text' | Show Post Description under Title |
|
||||||
| disableShare | boolean | true \| false | To hide/show share icons under a page |
|
| disableShare | boolean | true \| false | To hide/show share icons under a page |
|
||||||
| disableHLJS | | | |
|
| disableHLJS | boolean | true \| false | |
|
||||||
|
| searchHidden | boolean | true \| false | |
|
||||||
| ShowBreadCrumbs | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
|
| ShowBreadCrumbs | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
|
||||||
| author | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
|
| author | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
|
||||||
| cover.image | string | 'featured.jpg' | To add a cover image |
|
| cover.image | string | 'featured.jpg' | To add a cover image |
|
||||||
| cover.caption | string | 'caption for image' | To add caption to 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.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.relative | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles |
|
||||||
| cover.hidden | | | |
|
| cover.hidden | boolean | true \| false | |
|
||||||
| | | | |
|
| | | | |
|
||||||
| weight | integer | 5 | To set page order or to pin a post to Top of list |
|
| weight | integer | 5 | To set page order or to pin a post to Top of list |
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
- **[Home](./Home)**
|
- **[Home](./Home)**
|
||||||
- **[Installation](./Installation)**
|
- **[Install / Update](./Installation)**
|
||||||
- **[Features](./Features)**
|
- **[Features](./Features)**
|
||||||
- **[FAQs](./FAQs)**
|
- **[FAQs](./FAQs)**
|
||||||
- **[Variables](./Variables)**
|
- **[Variables](./Variables)**
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user