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 documentation of cover images (#53)

Browse Source
This commit is contained in:
Niek Blankers 2020-10-22 16:05:14 +02:00 committed by GitHub
parent 874528deaf
commit 9c5abbe7fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
content/posts/papermod/papermod-features.md
View File

@ -126,6 +126,22 @@ cover:
caption: '<text>' caption: '<text>'
``` ```
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:
responsiveImages: false
```
To enable hyperlinks to the full image size on post pages, use
```yml
params:
cover:
linkFullImages: true
```
--- ---
### Share Buttons on post ### Share Buttons on post

5
content/posts/papermod/papermod-variables.md
View File

@ -17,6 +17,8 @@ Below are variables used with this theme...
| ShowReadingTime | boolean | true \| false | | ShowReadingTime | boolean | true \| false |
| defaultTheme | string | light \| dark \| auto | | defaultTheme | string | light \| dark \| auto |
| ShowShareButtons | boolean | true \| false | | ShowShareButtons | boolean | true \| false |
| cover.linkFullImages | boolean | true \| false |
| cover.responsiveImages | boolean | true \| false |
### Page Variables ### Page Variables
@ -25,3 +27,6 @@ Below are variables used with this theme...
| showtoc | boolean | true \| false | | showtoc | boolean | true \| false |
| tocopen | boolean | true \| false | | tocopen | boolean | true \| false |
| hidemeta | boolean | true \| false | | hidemeta | boolean | true \| false |
| cover.image | string | `'featured.jpg'` |
| cover.caption | string | `'<text>'` |
| cover.alt | string | `'<alt text>'` |