Files
site/themes/minimo/exampleSite/content/docs/cover-image.md
2021-09-06 13:02:12 -04:00

41 lines
1.3 KiB
Markdown

---
date: 2017-09-30T14:00:00+06:00
lastmod: 2018-06-04T23:00:00+06:00
title: Cover Image
authors: ["muniftanjim"]
categories:
- features
slug: cover-image
cover:
image: /images/eden-farm-children-s-village.jpg
caption: Eden Farm Children's Village by [Gareth Harper](https://unsplash.com/photos/yACpBcInUos?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText)
style: full
---
You can add cover image to your contents with the **`cover`** paramameter in the content's front-matter.
You can directly provide the image url:
```yaml
---
cover: /images/eden-farm-children-s-village.jpg
---
```
- `cover` [`String`]: path/url of the cover image
Or you can provide additional information:
```yaml
---
cover:
image: /images/eden-farm-children-s-village.jpg
alternate: Picture of a yellow wall with a blue window in the upper-left corner
caption: Eden Farm Children's Village by Gareth Harper on Unsplash
style: full
---
```
- `cover` [`Map`]:
- `image` [`String`]: path/url of the cover image
- `alternate` [`String`]: alternate text for the image
- `caption` [`String`]: caption for the cover image
- `style` [`String`]: `full` / `wide` / `normal`