mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2025-05-21 10:25:10 -04:00
update docs from wiki
This commit is contained in:
Aditya Telange
parent
2dae7281f3
commit
b85471e946
3 changed files with 135 additions and 73 deletions
|
|
@ -14,33 +14,37 @@ weight: 5
|
|||
|
||||
### 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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `fuseOpts` | - | - | [Details](#fuseOpts) |
|
||||
| `socialIcons` | - | - | [Details](#socialIcons) |
|
||||
| `label` | - | - | [Details](#label) |
|
||||
| `assets` | - | - | [Details](#assets) |
|
||||
| `cover` | - | - | [Details](#cover) |
|
||||
| `profileMode` | - | - | [Details](#profilemode) |
|
||||
| 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 |
|
||||
| `DateFormat` | string | "January 2, 2006" | The format of date strings in the website. [Details](https://gohugo.io/functions/format/) |
|
||||
| `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 |
|
||||
| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button |
|
||||
| `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 |
|
||||
| `fuseOpts` | - | - | [Details](#fuseOpts) |
|
||||
| `socialIcons` | - | - | [Details](#socialIcons) |
|
||||
| `label` | - | - | [Details](#label) |
|
||||
| `assets` | - | - | [Details](#assets) |
|
||||
| `cover` | - | - | [Details](#cover) |
|
||||
| `profileMode` | - | - | [Details](#profilemode) |
|
||||
| `editPost` | - | - | [Details](#editPost) |
|
||||
|
||||
#### label
|
||||
|
||||
|
|
@ -117,25 +121,39 @@ socialIcons:
|
|||
url: "<link2>"
|
||||
```
|
||||
|
||||
#### editPost
|
||||
|
||||
```yml
|
||||
editPost:
|
||||
URL: "https://github.com/<path_to_repo>/content"
|
||||
Text: "Suggest Changes" # edit text
|
||||
appendFilePath: true # to append file path to Edit link
|
||||
```
|
||||
|
||||
> Note: Same format is being used by Page Variables
|
||||
|
||||
---
|
||||
|
||||
### 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 |
|
||||
| `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` | boolean | true \| false | To disable Highlight.js loading |
|
||||
| `searchHidden` | boolean | true \| false | Hide page from search |
|
||||
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
|
||||
| `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 |
|
||||
| `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` | boolean | true \| false | To disable Highlight.js loading |
|
||||
| `searchHidden` | boolean | true \| false | Hide page from search |
|
||||
| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `weight ` | integer | 5 | To set page order or to pin a post to Top of list |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue