The metadata.json file contains various configuration items that are needed to set up the blog. It controls things like title, URLs, tags, feeds, and some links. The metadata.json
file is located under _data/metadata.json
Starting with the important ones.
title
The site title that appears in the header. eg, “Joe’s Blog”
Eleventy Satisfactory
pathPrefix
Very important. The path where the blog will sit under its domain.
Examples:
/blog/
if it’s hosted on ‘https://example.com/blogs’/
if it’s hosted on ‘https://example.com’
/eleventy-satisfactory/
url
The Base URL where this site will be published. It gets used to construct the full URL to content, in the sitemap.xml, feed.xml, feed.json, and the OpenGraph and JSON-LD headers in the HTML <head>
.
Examples:
https://username.github.io/
https://example.com/blog/
https://code.mendhak.com/eleventy-satisfactory/
This value gets used to construct and correct various URLs throughout all content, such as images, links, stylesheets, etc.
Optional, but useful
paginationSize
How many post links should be shown per page.
4
description
Sets the site description in the HTML head’s meta and OpenGraph/JSON-LD descriptions, as well as the JSON and Atom feed.
If a blog post doesn’t contain a description:
frontmatter, this value gets used as a default in the HTML head.
Blog theme for Eleventy with various new features
tags
Sets the site’s tags in the HTML head’s meta keywords and OpenGraph/JSON-LD tags.
If a blog post doesn’t contain a tags:
frontmatter, these values get used as a default in the HTML head.
["eleventy","blog","theme","template","starter"]
language
Sets the HTML lang
of the web page. It helps search engines and browsers.
en
favicon
Path to the favicon. Add your own image to the /assets/images/
folder and update the location.
/assets/images/favicon.png
feed.path
The path where the Atom feed should be written to.
/feed.xml
jsonfeed.path
The path where the JSON feed should be written to.
/feed.json
author
name
: The author pseudonym or name that should appear in the HTML meta as well as the site’s footer.
email
: The author email that should appear in the Atom feed.
url
: The URL that should appear in the Atom feed.
{"name":"mendhak","email":"","url":"https://github.com/mendhak/eleventy-satisfactory"}
opengraph
Some opengraph settings.
image
: The image to use when an OpenGraph preview is being made for a URL on this site. If a blog post doesn’t have a opengraph.image
frontmatter, then this default image gets used instead. This value is also used in the JSON-LD data.
type
: The OpenGraph content type of this content. It’s a blog so, it’s an article.
{"image":"/assets/images/article.png","type":"article"}