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 profile mode docs

Aditya Telange 2021-02-07 00:05:25 +05:30
parent 717cc06d64
commit 4942f03c4c
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
3 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Features.md

@ -163,6 +163,7 @@ params:
profileMode: profileMode:
enabled: true enabled: true
title: "<Title>" # optional default will be site title title: "<Title>" # optional default will be site title
subtitle: "This is subtitle"
imageUrl: "<image link>" # optional imageUrl: "<image link>" # optional
imageTitle: "<title of image as alt>" # optional imageTitle: "<title of image as alt>" # optional
imageWidth: 120 # custom size imageWidth: 120 # custom size

1
Installation.md

@ -147,6 +147,7 @@ params:
profileMode: profileMode:
enabled: false # needs to be explicitly set enabled: false # needs to be explicitly set
title: ExampleSite title: ExampleSite
subtitle: "This is subtitle"
imageUrl: "<img location>" imageUrl: "<img location>"
imageWidth: 120 imageWidth: 120
imageHeight: 120 imageHeight: 120

19
Variables.md

@ -47,14 +47,15 @@
#### profileMode #### profileMode
| name | type | example | Description | | name | type | example | Description |
| ----------------------- | ------- | ---------------------------------------------- | ----------- | | ----------------------- | ------- | ---------------------------------------------- | ---------------------------------------------------- |
| profileMode.enabled | boolean | true \| false | | | profileMode.enabled | boolean | true \| false | For enabling profileMode, needs to be explicitly set |
| profileMode.title | string | "Title" | | | profileMode.title | string | "Title" | Title |
| profileMode.imageUrl | string | "image.png" \| "https://example.com/image.jpg" | | | profileMode.subtitle | string | "subtitle here" | Subtitle |
| profileMode.imageWidth | string | "" | | | profileMode.imageUrl | string | "image.png" \| "https://example.com/image.jpg" | Image URL or Link |
| profileMode.imageHeight | string | "" | | | profileMode.imageWidth | string | "150" | Width of image |
| profileMode.imageTitle | string | "This image is a picture of .." | | | profileMode.imageHeight | string | "150" | Height of image |
| profileMode.buttons | - | - | | | profileMode.imageTitle | string | "This image is a picture of .." | Title of image |
| profileMode.buttons | - | - | [Details](#profileMode.buttons) |
#### assets #### assets
@ -97,7 +98,7 @@ socialIcons:
url: "<link2>" url: "<link2>"
``` ```
#### #### profileMode.buttons
```yml ```yml
profileMode: profileMode: