refactor: move profile size from img to degicated avatar shortcode (#817)
BREAKING CHANGE: The `size=profile` option was removed from the `img` shortcode. To create avatar images the new `avatar` shortcode can be used.
This commit is contained in:
parent
7b52c98f17
commit
6eb576575e
6 changed files with 134 additions and 25 deletions
46
exampleSite/content/en/shortcodes/avatar/_index.md
Normal file
46
exampleSite/content/en/shortcodes/avatar/_index.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: Avatar
|
||||
resources:
|
||||
- name: avatar
|
||||
src: "avatar.jpg"
|
||||
title: "Avatar"
|
||||
---
|
||||
|
||||
The avatar shortcode is another custom image shortcode.
|
||||
|
||||
<!--more-->
|
||||
|
||||
## Usage
|
||||
|
||||
Define a resource in the page front matter.
|
||||
|
||||
<!-- spellchecker-disable -->
|
||||
|
||||
```md
|
||||
---
|
||||
resources:
|
||||
- name: avatar
|
||||
src: "images/avatar.jpg"
|
||||
title: "Avatar"
|
||||
---
|
||||
|
||||
{{</* avatar name="avatar" */>}}
|
||||
```
|
||||
|
||||
<!-- spellchecker-enable -->
|
||||
|
||||
## Attributes
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- spellchecker-disable -->
|
||||
{{< propertylist name=shortcode-avatar sort=name order=asc >}}
|
||||
<!-- spellchecker-enable -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Example
|
||||
|
||||
<!-- spellchecker-disable -->
|
||||
|
||||
{{< avatar name=avatar size="small" >}}
|
||||
|
||||
<!-- spellchecker-enable -->
|
BIN
exampleSite/content/en/shortcodes/avatar/avatar.jpg
Normal file
BIN
exampleSite/content/en/shortcodes/avatar/avatar.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 72 KiB |
18
exampleSite/data/properties/shortcode-avatar.yaml
Normal file
18
exampleSite/data/properties/shortcode-avatar.yaml
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
properties:
|
||||
- name: name
|
||||
type: string
|
||||
description: Name of the image resource defined in page front matter.
|
||||
required: true
|
||||
- name: alt
|
||||
type: string
|
||||
description: Description text for the image.
|
||||
required: false
|
||||
- name: size
|
||||
type: string
|
||||
description: Thumbnail size. Supported values are `origin|tiny|small|medium|large`.
|
||||
required: false
|
||||
- name: anchor
|
||||
type: string
|
||||
description: "[Anchor](https://gohugo.io/content-management/image-processing/#anchor) to determine the placement of the crop box."
|
||||
required: false
|
|
@ -2,7 +2,7 @@
|
|||
properties:
|
||||
- name: name
|
||||
type: string
|
||||
description: Mame of the image resource defined in page front matter.
|
||||
description: Name of the image resource defined in page front matter.
|
||||
required: true
|
||||
- name: alt
|
||||
type: string
|
||||
|
@ -10,7 +10,7 @@ properties:
|
|||
required: false
|
||||
- name: size
|
||||
type: string
|
||||
description: Thumbnail size. Supported values are `origin|profile|tiny|small|medium|large`.
|
||||
description: Thumbnail size. Supported values are `origin|tiny|small|medium|large`.
|
||||
required: false
|
||||
- name: lazy
|
||||
type: bool
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue