Feature Images
Series: Documentation
- 1. Introduction
- 2. Getting Started
- 3. Color Schemes
- 4. Directory Structure and Assets
- 5. Feature Images
- 6. Favicon
- 7. Series
- 8. Archive
- 9. Search
- 10. Backlinks
- 11. Related Article
- 12. Rich Content
- 13. Markdown and Hugo
- 14. Customization
- 15. Reference - Configuration
- 16. Reference - Front matter
- 17. Reference - Icons
Feature images in Yore serve multiple purposes: they appear as hero banners, thumbnails, and social sharing metadata. This functionality relies on Hugo page bundles.
Automatic Detection
When using index.md inside a directory (creating a leaf bundle), Yore automatically detects images with the feature* prefix and uses them as the page's feature image.
For example, this structure:
content/
└── posts/
└── my-article/
├── index.md
└── feature.webpwill automatically use feature.webp as the hero image, thumbnail, and social sharing image.
Manual Configuration
You can explicitly specify a feature image using the pageFeatureImage parameter in front matter:
---
title: My Article
params:
# Specifies the image in `assets/img/07.jpg`
pageFeatureImage: img/07.jpg
---The params field contains theme-specific configuration, not Hugo core settings.
Hero Image Styles
The pageHeroStyle parameter controls how the hero image is displayed. This can be set globally in site configuration or overridden per page:
---
title: My Article
params:
pageFeatureImage: img/07.jpg
pageHeroStyle: background
---Available styles are:
big: Large hero image at full content widthbackground: Full-width background image with text overlaydisable: No hero image display (image still used for metadata)
Series: Documentation
- 1. Introduction
- 2. Getting Started
- 3. Color Schemes
- 4. Directory Structure and Assets
- 5. Feature Images
- 6. Favicon
- 7. Series
- 8. Archive
- 9. Search
- 10. Backlinks
- 11. Related Article
- 12. Rich Content
- 13. Markdown and Hugo
- 14. Customization
- 15. Reference - Configuration
- 16. Reference - Front matter
- 17. Reference - Icons