Front matter SEO reference

The supported metadata fields for posts in this blog starter.

1 min read

Post info

1 min read
Edit on GitHub

Use front matter to keep the article body clean while still giving the blog enough metadata to build rich pages.

FieldRequiredPurpose
titleYesPage title, archive card title, and fallback SEO title.
descriptionYesArchive summary and fallback meta description.
dateYesPublish date for sorting, sitemap, RSS, and JSON-LD.
updatedNoModified date for article metadata.
authorYesGitHub usernames for the post authors.
tagsNoFilters, article metadata, and keyword hints.
imageNoHeader image shown below the post title and description.
canonicalUrlNoOverrides the canonical URL when syndicating content.
seo.imageNoOverrides the default social image.

Drafts

Set published: false to keep a file in the repository without showing it in production output.

published: false

Every post knows its source path. The post page combines that path with repositoryUrl and repositoryBranch from blog-settings.json to create the Edit on GitHub link.