hugo-PaperMod/content/posts/papermod/papermod-features.md

256 lines
4.7 KiB
Markdown
Raw Normal View History

2020-09-17 04:58:09 -04:00
---
title: "Papermod - Features"
date: 2020-09-16T11:30:03+05:30
showToc: true
weight: 2
aliases: ['/papermod-features']
tags: ['PaperMod']
author: "Aditya Telange"
2020-09-24 02:24:04 -04:00
tocopen: true
2020-09-17 04:58:09 -04:00
---
2020-10-06 03:31:20 -04:00
### Assets (js/css)
2020-09-17 04:58:09 -04:00
The following is enabled by default
- [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible.
- [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset
- [fingerprint/intergity](https://gohugo.io/hugo-pipes/fingerprint/) check.
---
2020-10-06 03:31:20 -04:00
### Default Theme light/dark/auto
2020-09-17 04:58:09 -04:00
```yml
params:
2020-10-06 03:31:20 -04:00
# defaultTheme: light
# defaultTheme: dark
defaultTheme: auto # to switch between dark or light according to browser theme
2020-09-17 04:58:09 -04:00
```
2020-10-06 03:31:20 -04:00
</details>
2020-09-17 04:58:09 -04:00
2020-10-06 03:31:20 -04:00
---
2020-09-17 04:58:09 -04:00
2020-10-06 03:31:20 -04:00
### Theme Switch Toggle (enabled by default)
2020-09-24 01:48:03 -04:00
2020-10-06 03:31:20 -04:00
Shows icon besides title of page to change theme
To disable it :
2020-09-24 01:48:03 -04:00
```yml
2020-10-06 03:31:20 -04:00
disableThemeToggle : true
2020-09-24 01:48:03 -04:00
```
2020-09-17 04:58:09 -04:00
---
2020-10-06 03:31:20 -04:00
### Archives Layout
2020-09-17 04:58:09 -04:00
Create a page with `archive.md` in `content` directory with following content
2020-09-17 04:58:09 -04:00
```yml
---
title: "Archive" # in any language you want
layout: "archives" # is necessary
url: "/archive"
summary: "archive"
---
2020-09-17 04:58:09 -04:00
```
**Note:** Archives Layout does not support Multilingual Month Translations.
2020-10-06 03:31:20 -04:00
ex: [archives.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md)
2020-09-17 04:58:09 -04:00
---
2020-10-06 03:31:20 -04:00
### Home-Info Mode
2020-09-17 04:58:09 -04:00
Use 1st entry as some Information
add following to config file
```yml
params:
homeInfoParams:
Title: Hi there wave
Content: Can be Info, links, about...
socialIcons: # optional
- name: "<platform>"
url: "<link>"
- name: "<platform 2>"
url: "<link2>"
```
ex. [here](https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.toml#L14)
![](https://i.ibb.co/zsq6fLr/papermod-homeinfo.png)
---
2020-10-06 03:31:20 -04:00
### Profile Mode
2020-09-17 04:58:09 -04:00
Shows Index/Home page as Full Page with Social Links and Image
add following to config file
```yml
params:
profileMode:
enabled: true
title: "<Title>" # optional default will be site title
imageUrl: "<image link>" # optional
imageTitle: "<title of image as alt>" # optional
buttons:
- name: Archive
url: "/archive"
- name: Github
url: "https://github.com/"
socialIcons: # optional
- name: "<platform>"
url: "<link>"
- name: "<platform 2>"
url: "<link2>"
```
![](https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png)
---
2020-10-06 03:31:20 -04:00
### Draft Page indication
2020-09-17 04:58:09 -04:00
adds `[draft]` mark to indicate draft pages.
---
2020-10-06 03:31:20 -04:00
### Post Cover Image
2020-09-24 01:48:03 -04:00
In post's page-variables add :
```yml
2020-10-06 03:31:20 -04:00
cover:
image: '<image path/url>'
# can also paste direct link from external site
# ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png
alt: '<alt text>'
caption: '<text>'
2020-09-24 01:48:03 -04:00
```
When you include images in the [Page Bundle](https://gohugo.io/content-management/page-bundles/), multiple sizes of the image will automatically be provided using the HTML5 `srcset` field.
To reduce generation time and size of the site, you can disable this feature using
```yml
params:
cover:
2020-10-25 03:48:45 -04:00
responsiveImages: false
```
To enable hyperlinks to the full image size on post pages, use
```yml
params:
cover:
linkFullImages: true
```
2020-09-24 02:24:04 -04:00
---
2020-10-06 03:31:20 -04:00
### Share Buttons on post
2020-09-17 04:58:09 -04:00
Displays Share Buttons at Bottom of each post
to show share buttons add
```yml
params:
ShowShareButtons: true
```
---
2020-10-06 03:31:20 -04:00
### Show post reading time
2020-09-17 04:58:09 -04:00
Displays Reading Time (the estimated time, in minutes, it takes to read the content.)
To show reading time add
```yml
Params:
ShowReadingTime: true
```
---
2020-10-06 03:31:20 -04:00
### Show Table of Contents (Toc) on blog post
2020-09-17 04:58:09 -04:00
Displays ToC on blog-pages
To show ToC add following to page-variables
```yml
ShowToc: true
```
2020-09-24 02:24:04 -04:00
To keep Toc Open **by default** on a post add following to page-variables:
2020-09-24 01:48:03 -04:00
```yml
TocOpen: true
```
2020-09-17 04:58:09 -04:00
---
2020-10-25 03:48:45 -04:00
### Multiple Authors
To Use multiple authors for a post, in post-variables:
```yml
---
author: ["Me", "You"]
---
```
To use Multiple Authors Site-wide, in `config.yml`:
```yml
params:
author: ["Me", "You"]
```
---
2020-10-06 03:31:20 -04:00
### Comments
2020-09-17 04:58:09 -04:00
to add comments, create a html file
`layouts/partials/comments.html`
and paste code provided by your comments provider
also in config add this
2020-09-24 02:24:04 -04:00
2020-09-17 04:58:09 -04:00
```yml
params:
comments: true
```
2020-09-24 02:24:04 -04:00
read more about this [here](https://gohugo.io/content-management/comments/)
2020-09-17 04:58:09 -04:00
---
2020-10-06 03:31:20 -04:00
### Misc
2020-09-17 04:58:09 -04:00
2020-10-06 03:31:20 -04:00
#### Scroll-Bar themed (by default)
#### Smooth Scroll between in-page links (by default)
#### Scroll-to-Top Button (by default)
Displays a Scroll-to-Top button in right-bottom corner
#### Google Analytics integration
#### Open-Graph support
#### Twitter Cards Support
#### Syntax highlighting
#### Twitter cards and opengraph tags support
#### RSS feeds
2020-09-17 04:58:09 -04:00
#### Multilingual Support