Page headers

Available configuration options

Here are all the available page configuration options:

---
title: My Page Title
description: A brief description
authors: ["John Doe", "Jane Smith"]
date: 2024-03-06
image: content/assets/my-image.jpg
---

Title

The title field sets your page's title and is displayed in page header.

It's also used in:

• Page header
• Sidebar navigation
• Browser tab title
• Search engine result title
• Social media preview title

Description

The description field provides a brief summary of your page content and is displayed in page header.

It's also used in:

• Search engine result snippet
• Social media preview description

Authors

The authors field lets you specify one or more authors for the page. Authors are displayed in page header.

authors: ["John Doe"]           # Single author
authors: ["John", "Jane"]       # Multiple authors

See Page authors for details on creating dedicated author pages with avatars.

Date

The date field sets the publication date for your page and is displayed in page header.

date: 2024-03-06 # YYYY-MM-DD format

Featured image

The image field sets a featured image for your page.

It's also is used in:

• Social media preview cards¹

When someone shares your page on platforms like Twitter, LinkedIn, or Facebook, the featured image will be used to create a rich preview card, making your content stand out in social feeds.

For example:

You can specify your featured image in two ways:

1. Repository Path: Use a relative or absolute path to an image in your repository
2. External URL: Link to an image hosted elsewhere on the web

Adding a featured image

Add the image field to your page's frontmatter:

---
title: My Page
image: content/assets/my-image.jpg # relative path
---

Or use an absolute path from your repository root:

---
title: My Page
image: /content/assets/my-image.jpg # absolute path
---

You can also use external URLs:

---
title: My Page
image: https://example.com/my-image.jpg # external URL
---

Best practices

• Use descriptive titles and descriptions for better SEO
• Include featured images when possible for better social sharing
• Recommended image dimensions: 1200x630 pixels (1.91:1 ratio) for optimal social media sharing
• Keep image file sizes reasonable (under 1MB) for better performance
• Use high-quality, relevant images with good contrast; avoid text in images as social platforms may add their own
• Respect image copyright: use your own images, properly licensed photos, or images from free stock photo sites
• Use ISO date format (YYYY-MM-DD) for dates

Testing featured images

After adding a featured image:

1. Wait for your site to sync
2. View your page to see the featured image
3. Test how it looks when shared using social media preview tools or by sharing the page on a test account

Footnotes

1. Custom social share images are only available on premium sites. ↩