Skip to content

Commit 5aa358c

Browse files
Document twitter cards and open-graph support (#513)
1 parent e784e1f commit 5aa358c

File tree

1 file changed

+42
-4
lines changed
  • content/posts/papermod/papermod-features

1 file changed

+42
-4
lines changed

content/posts/papermod/papermod-features/index.md

+42-4
Original file line numberDiff line numberDiff line change
@@ -438,10 +438,48 @@ t - Theme toggle
438438

439439
- [Rich Results/Snippets Support](https://support.google.com/webmasters/answer/7506797?hl=en)
440440

441-
- Twitter Cards Support
442-
443-
- Open-Graph support
444-
441+
#### Twitter Cards Support
442+
443+
* The Twitter Cards metadata, except ``twitter:image`` should not require
444+
additional configuration, since it is generated from metadata that
445+
you should already have (for instance the page title and description).
446+
* The ``twitter:image`` uses the [Post Cover Image](#post-cover-image), if present.
447+
* In the absence of a cover images, the first image from the ``images``
448+
frontmatter (a list) is used.
449+
```yaml
450+
images:
451+
- image_01.png
452+
- image_02.png
453+
```
454+
* Finally, if neither of those are provided, ``twitter:image`` comes from the first
455+
[Page Bundle](https://gohugo.io/content-management/page-bundles/)
456+
image with ``feature`` in the name, with a fallback to the first image with
457+
``cover`` or ``thumbnail`` in the name.
458+
459+
#### OpenGraph support
460+
461+
* The OpenGraph metadata, except ``og:image`` should not require
462+
additional configuration, since it is generated from metadata that
463+
you should already have (for instance the page title and description).
464+
* The ``og:image`` uses the [Post Cover Image](#post-cover-image), if present.
465+
* In the absence of a cover images, the first image from the ``images``
466+
frontmatter (a list) is used.
467+
```yaml
468+
images:
469+
- image_01.png
470+
- image_02.png
471+
```
472+
* Finally, if neither of those are provided, ``og:image`` comes from the first
473+
[Page Bundle](https://gohugo.io/content-management/page-bundles/)
474+
image with ``feature`` in the name, with a fallback to the first image with
475+
``cover`` or ``thumbnail`` in the name.
476+
* For pages, you can also add audio (using frontmatter ``audio: filename.ext``) and/or
477+
videos.
478+
```yaml
479+
videos:
480+
- filename01.mov
481+
- filename02.avi
482+
```
445483
---
446484

447485
### Multilingual Support

0 commit comments

Comments
 (0)