You are currently viewing the BETA version of Front Matter documentation. Click on the banner to go to the main release documentation.

Fields overview

Supported field types

Front Matter supports the following fields to be used in the content-types:

There are also the following section fields:

Standard field properties

All fields share the following field properties:

PropertyTypeDescriptionOptional / Required
namestringThe name of your field, will be used to set in the front matter of your Markdown file.Required
typestringThe type of the field. Use one of the supported field types.Required
titlestringThe title to show in the metadata sectionOptional
descriptionstringThe description to show underneath the fieldOptional
defaultstringDefines the default value for the field when creating the content type. You can also use placeholders like {{title}}, {{slug}} or {{now}}. Check for more information under placeholders.Optional
requiredbooleanDefines if the field is required or not. If set to true, and the user does not define a value, a notification will appear. You can disable this notification with the frontMatter.global.disabledNotifications setting.Optional
hiddenbooleanSpecifies if you want to hide the field from the metadata section, but still have it available in Front Matter.Optional
actionsobjectDefines the custom actions/scripts that you can execute to populate the field valueOptional

String

The string field type is used to store a single-line or multiline of text. For instance, you can use if for the title, description, or any other text field.

Properties

PropertyTypeDescriptionRequiredDefault
singlebooleanWhen set to true, the field will be rendered as a single line.Optionalfalse
wysiwygboolean, html or markdownWhen set to true, the field will be rendered as a WYSIWYG editor and output HTML. You can also provide html or markdown its value to define the field's output.Optionalfalse

WYSIWYG controls

Usage 
{
  "title": "Title",
  "name": "title",
  "type": "string",
  "single": true
}
Outcome 
---
title: "My title"
---

Number

The number field allows you to insert integer values, like for instance setting the weight of your content.

Properties

To configure the number field, you can specify the following properties in the numberOptions field property:

PropertyTypeDescriptionRequiredDefault
minnumberThe minimum value for the field.Optional
maxnumberThe maximum value for the field.Optional
stepnumberThe step value for the field.Optional
isDecimalbooleanWhen set to true, the field will allow decimal/floating values.Optionalfalse

Example 1

Usage
Define number field without any special configuration 
{
  "title": "Weight",
  "name": "weight",
  "type": "number"
}
Outcome 
---
weight: 1
---

Example 2

Usage
Define number field with a minimum, maximum, and step value 
{
  "title": "Weight",
  "name": "weight",
  "type": "number",
  "numberOptions": {
    "min": 1,
    "max": 10,
    "step": 1
  }
}
Outcome 
---
weight: 1
---

Example 3

Usage
Define number field with decimal values 
{
  "title": "Weight",
  "name": "weight",
  "type": "number",
  "numberOptions": {
    "isDecimal": true
  }
}
Outcome 
---
weight: 1.5
---

Datetime

The datetime field allows you to add date fields. You can use it for publish, modified, and any other types of dates for you content.

Properties

PropertyTypeDescriptionRequiredDefault
isPublishDatebooleanSpecifies if the field is a publish date. When set to true, the field will be used to set the publish date for the content (this will be reflected on the content dashboard).Optionalfalse
isModifiedDatebooleanSpecifies if the field is a modified date. When using the frontMatter.content.autoUpdateDate setting to automatically update the modified date of the article, this field will be used.Optionalfalse
dateFormatstringSpecifies the format of the date. By default it uses ISO format.Optional
Info

The format of your date can be defined in the frontMatter.taxonomy.dateFormat setting (globally), or with the dateFormat on the field level. To format the date, use the date-fns formating for more information.

Usage 
{
  "title": "Publishing date",
  "name": "date",
  "type": "datetime",
  "isPublishDate": true
},
{
  "title": "Last modified date",
  "name": "lastmod",
  "type": "datetime",
  "isModifiedDate": true
},
{
  "title": "Date formatting",
  "name": "dateWithFormat",
  "type": "datetime",
  "default": "{{now}}",
  "dateFormat": "yy-MM-dd"
}
Outcome 
---
date: 2022-03-14T08:42:21.626Z
lastmod: 2022-03-14T08:42:22.364Z
dateWithFormat: 23-07-16
---

Boolean

The boolean field can be used to set a value of true or false into your markdown. It will be rendered as a toggle.

Usage 
{
  "title": "Published",
  "name": "isPublished",
  "type": "boolean"
}
Outcome 
---
isPublished: true
---

Choice

The choice field allows you to define a set of options.

Properties

PropertyTypeDescriptionRequiredDefault
choicesstring[] or { id: string; title: string; }[]Define the choices for the field.Required
multiplebooleanDefine if you want to allow multiple choice selection.Optionalfalse

Example 1

Usage
Example of using an array of string values 
{
  "title": "Choice",
  "name": "choice",
  "type": "choice",
  "choices": ["", "Choice 1", "Choice 2", "Choice 3"]
}
Outcome
Outcome when using string values 
---
choice: "Choice 1"
---

Example 2

Usage
Example of using an array of { id: string; title: string; } objects 
{
  "title": "Choice",
  "name": "choice",
  "type": "choice",
  "choices": [
    { "id": "1", "title": "Choice 1" },
    { "id": "2", "title": "Choice 2" },
    { "id": "3", "title": "Choice 3" }
  ]
}
Outcome
Outcome when using id/title objects 
---
choice: "1"
---

List

The list field allows you to add multiple text values.

Usage
Example of using the list field 
{
  "title": "Alias",
  "name": "alias",
  "type": "list"
}
Outcome 
---
alias:
  - release-notes-v8
  - changelog-v8
---

Draft

The draft field defines the state of your content. This is used for the content dashboard as well. By default, the draft field is a boolean. If you want to use your own status values, you can configure it via the frontmatter.content.draftfield setting.

When using a custom draft status, the content dashboard will make use of it as well:

Draft filters

Important

If you use Jekyll, you do not have to use the draft field, as Front Matter supports the _drafts, _posts folders and collections from Jekyll. If you use Jekyll, make sure to set the frontMatter.framework.id setting to jekyll.

Example 1

Usage
Using the default draft experience 
{
  "title": "Draft",
  "name": "draft",
  "type": "draft"
}
Outcome
Default draft field outcome 
---
draft: true
---

Example 2

In case you want to use a published field, instead of a draft field. You can invert the logic by setting the invert property to true:

Draft field setting
Example of how to invert the field value 
"frontMatter.content.draftField": {
  "name": "published",
  "type": "boolean",
  "invert": true
}
Usage
Draft field configuration 
{
  "title": "Published",
  "name": "published",
  "type": "draft"
}
Outcome
Outcome of using a inverted field value 
---
published: false
---

Example 3

If you want to use your own status values, you can define it by specifying these in the frontMatter.content.draftField setting:

Draft field setting
Change the field type to a choice list 
"frontMatter.content.draftField": {
  "name": "draft",
  "type": "choice",
  "choices": ["draft", "in progress", "published"]
}
Usage
The field definition 
{
  "title": "Draft",
  "name": "draft",
  "type": "draft"
}
Outcome
Outcome of using your own status values 
---
draft: "in progress"
---

Image

The image field can be used to reference single or multiple images to your content.

Properties

PropertyTypeDescriptionRequiredDefault
isPreviewImagebooleanAllows you to specify a custom preview image for your article. When you set this to true for an image field in your content type, it will be adopted in the dashboard.Optionalfalse
multiplebooleanDefine if you want to allow to select multiple images.Optionalfalse
Important

You can only set this on one image field per content type.

Usage 
{
  "title": "Article preview",
  "name": "preview",
  "type": "image",
  "isPreviewImage": true
}
Outcome 
---
preview: /social/400285cf-4928-4c07-8ca5-158f249a3bc1.png
---

File

The file field can be used to reference single or multiple files to your content.

Properties

PropertyTypeDescriptionRequiredDefault
multiplebooleanDefine if you want to allow to select multiple files.Optionalfalse
fileExtensionsstring[]Define the file extensions that are allowed to be selected.Optional[]
Usage 
{
  "title": "Attachments",
  "name": "attachments",
  "type": "file",
  "multiple": true,
  "fileExtensions": ["pdf", "mp4", "wav"]
}
Outcome 
---
attachments:
  - /uploads/file1.pdf
  - /uploads/file2.mp4
---

Tags

The tags field allows you to create or use tags from your .frontmatter/database/taxonomyDb.json file (by default, none existing). When adding a tag which does not yet exist, you will have the option to create it.

Add a new tag

When the tag is created, you will be able to re-use it for other content.

Info

You can add multiple tags at once by entering them as comma-separated values and pressing the ENTER key.

Properties

PropertyTypeDescriptionRequiredDefault
taxonomyLimitnumberDefines the maximum number of items that can be selected. By default set to 0 which allows unlimited items to be selected.Optional0
singleValueAsStringbooleanWhen set to true, a single value will be added as a string value instead of an array.Optionalfalse
Info

When a limit is defined, this will get reflected in the UI as well:

Taxonomy limit

Usage 
{
  "title": "Tags",
  "name": "tags",
  "type": "tags"
}
Outcome 
---
tags:
  - Development
  - GitHub
  - GraphQL
  - API
---

Categories

The categories field is similar to the tags field. Categories are also stored in the .frontmatter/database/taxonomyDb.json file.

Properties

PropertyTypeDescriptionRequiredDefault
taxonomyLimitnumberDefines the maximum number of items that can be selected. By default set to 0 which allows unlimited items to be selected.Optional0
singleValueAsStringbooleanWhen set to true, a single value will be added as a string value instead of an array.Optionalfalse
Usage 
{
  "title": "Categories",
  "name": "categories",
  "type": "categories"
}
Outcome 
---
categories:
  - Development
---

Taxonomy

The taxonomy is similar to the tags and categories field, but allows you to define your own taxonomy values and structure.

Properties

PropertyTypeDescriptionRequiredDefault
taxonomyLimitnumberDefines the maximum number of items that can be selected. By default set to 0 which allows unlimited items to be selected.Optional0
taxonomyIdstringSet the id of your custom taxonomy definition defined in the frontMatter.taxonomy.customTaxonomy setting.Required
singleValueAsStringbooleanWhen set to true, a single value will be added as a string value instead of an array.Optionalfalse

Custom taxonomy

The frontMatter.taxonomy.customTaxonomy setting allows you to provide a list of custom taxonomy data. Each of the taxonomy data contains a id and an array of options.

Here is an example of the custom taxonomy setting definition:

Custom taxonomy
Define your custom taxonomy options 
"frontMatter.taxonomy.customTaxonomy": [
  {
    "id": "customTaxonomy",
    "options": [
      "Option 1",
      "Option 2",
      "Option 3"
    ]
  }
]
Usage
Custom taxonomy field definition 
{
  "title": "Custom taxonomy",
  "name": "customTags",
  "type": "taxonomy",
  "taxonomyId": "customTaxonomy"
}
Outcome 
---
customTags:
  - custom-development
---

Fields

The fields field, allows you to create multi-dimensional content type fields (sub-fields). This is useful when you want to create a complex content type. In case you want to define a list data, you will have to use the block field.

When you specify the field type as fields, you need to define sub-fields within the fields property.

Properties

PropertyTypeDescriptionRequiredDefault
fieldsobject[]Define the sub-fields of your content type. All the above types are supported.Required
Usage 
{
  "frontMatter.taxonomy.contentTypes": [
    {
      "name": "multi-dimensional",
      "pageBundle": false,
      "fields": [
        ...
        {
          "title": "Photo",
          "type": "fields",
          "name": "photo",
          "fields": [
            {
              "title": "Title",
              "name": "title",
              "type": "string"
            },
            {
              "title": "URL",
              "name": "url",
              "type": "image"
            }
          ]
        }
      ]
    }
  ]
}

Multi-dimensional content type fields

Outcome 
---
photo:
  title: "Photo 1"
  url: /social/400285cf-4928-4c07-8ca5-158f249a3bc1.png
---

fieldCollection

The fieldCollection field type allows you to reuse fields in multiple content types. This is especially useful when you have a lot of content types and want to reuse the same fields.

Prerequisites

To work with the fieldCollection field type, you need to define a field group (a set of fields for your data) in the frontMatter.taxonomy.fieldGroups setting.

Field group definition to be used in the fieldCollection 
"frontMatter.taxonomy.fieldGroups": [
  {
    "id": "GeneralFields",
    "fields": [
      {
        "title": "Title",
        "name": "title",
        "type": "string",
        "single": true
      },
      {
        "title": "Description",
        "name": "description",
        "type": "string"
      }
    ]
  }
]

Properties

PropertyTypeDescriptionRequiredDefault
fieldGroupstringDefine the field group that will be used to create a list of data.Required

Block

The block field type allows you to define a group of fields which can be used to create a list of data.

Block field type rendering

Prerequisites

To work with the block field type, you need to define a field group (a set of fields for your data) in the frontMatter.taxonomy.fieldGroups setting.

Field group definition 
"frontMatter.taxonomy.fieldGroups": [
  {
    "id": "author",
    "labelField": "name",
    "fields": [
      {
        "title": "Author Name",
        "name": "name",
        "type": "string",
        "single": true
      },
      {
        "title": "Social link",
        "name": "social",
        "type": "string",
        "single": true
      }
    ]
  }
]
Info

You can use the same field types as you would use in the regular content types.

Properties

PropertyTypeDescriptionRequiredDefault
fieldGroupstring[]Define the field group(s) that will be used to create a list of data.Required
Usage 
"frontMatter.taxonomy.contentTypes": [
  {
    "name": "page",
    "fields": [
      {
        "title": "Authors",
        "name": "authors",
        "type": "block",
        "fieldGroup": [
          "author"
        ]
      },
      ...
  }
]
Important

If you want, you can also create field groupings within the field grouping. This is useful when you want to create sub-groups of data.

Outcome 
---
authors:
  - name: Elio Struyf
    social: https://twitter.com/eliostruyf
    fieldGroup: author
---

Data file

The dataFile field type allows you to use a data file to populate the field with a list of options. For instance, if you have a data file with all the authors of your site, you can use the dataFile field type to populate the authors field with the data from the authors data file.

dataFile field

Prerequisites

To use the dataFile field type, you need to have a definition for a data file in place. Here is an example of the authors sample:

Data file definition 
{
  "frontMatter.data.files": [
    {
      "id": "authors",
      "title": "Authors",
      "file": "[[workspace]]/data/authors.json", // Adapt to your needs
      "schema": {
        "title": "Author",
        "type": "object",
        "required": ["name", "url"],
        "properties": {
          "slug": {
            "title": "slug",
            "type": "string"
          },
          "name": {
            "title": "name",
            "type": "string"
          },
          "url": {
            "title": "url",
            "type": "string"
          }
        }
      }
    }
  ]
}

Properties

PropertyTypeDescriptionRequiredDefault
dataFileIdstringSpecify the ID of the data file to use for this field.Required
dataFileKeystringSpecify the key of the data file to use for this field.Required
dataFileValuestringSpecify the property name that will be used to show the value for the field.Optional
multiplebooleanSpecify if you want to select one or multiple records.Optionalfalse
Usage 
"frontMatter.taxonomy.contentTypes": [
  {
    "name": "page",
    "fields": [
      {
        "title": "Author",
        "name": "author",
        "type": "dataFile",
        "dataFileId": "authors",
        "dataFileKey": "slug",
        "dataFileValue": "name",
        "multiple": true
      },
      ...
  }
]
Outcome 
---
author:
  - dorothy-parker
---

Slug

The slug field allows you to create/update the slug of the current page.

Slug field

Properties

PropertyTypeDescriptionRequiredDefault
editablebooleanSpecify if you allow manual changes, or if the slug is generated automatically.Optionaltrue
Usage 
{
  "title": "Slug",
  "name": "slug",
  "type": "slug",
  "editable": true,
  "default": "{{slug}}"
}
Outcome 
---
slug: version-8-0-0-release-notes
---
Info

The slug is generated based on the title of the page. More information about it can be found in the slug documentation section.

contentRelationship

The contentRelationship field type allows you to create relationships between content. It can for instance be used to reference an author, or a related blog post.

Properties

PropertyTypeDescriptionRequiredDefault
contentTypeNamestringThe name of the content-type to link.Required
contentTypeValuestringThe type of link/value you want to add. This can be slug, or path.Required
sameContentLocalebooleanSpecify if you want to use the same content's locale for the relationship field.Optionaltrue
multiplebooleanSpecify if you want to select one or multiple relationships.Optionalfalse

Example 1

Usage of single selection 
{
  "title": "Session",
  "name": "session",
  "type": "contentRelationship",
  "contentTypeName": "session",
  "contentTypeValue": "slug"
}
Outcome of single selection 
---
session: /session-slug/
---

Example 2

Usage of multi-selection 
{
  "title": "Session",
  "name": "session",
  "type": "contentRelationship",
  "contentTypeName": "session",
  "contentTypeValue": "slug",
  "multiple": true
}
Outcome of multi-selection 
---
session: 
  - /session1-slug/
  - /session2-slug/
---

customField

The customField field type allows you to create and add your own fields to render.

Important

This is an experimental feature, and might change in the future. To use it, you need to enable the exeperimental features, more information about it can be found in the experimental features section.

Properties

PropertyTypeDescriptionRequiredDefault
customTypestringThe name of the custom field type to use.Required
Usage 
{
  "title": "Custom field",
  "name": "customField",
  "type": "customField",
  "customType": "customField"
}

The outcome depends on your custom field implementation.

Info

Check out registering a custom field for a sample implementation.

Divider

The divider field type allows you to add a divider to your content type. This is useful when you want to group fields together.

Properties

You only need to specify the type property and name:

Usage 
{
  "name": "divider",
  "type": "divider"
}

Outcome

Section divider field

Heading

The heading field type allows you to add a heading to your content type. This is useful when you want to group fields together.

Usage 
{
  "title": "Section title",
  "name": "sectionTitleWithDescription",
  "description": "This is just a dummy description to test out the field description",
  "type": "heading"
},
{
  "title": "Section title without description",
  "name": "sectionTitleWithoutDescription",
  "type": "heading"
}

Outcome

Section heading field

Edit page
Previous← Content typesNextField conditions →

Feedback/comments

Last updated on

Did you spot an issue in our documentation, or want to contribute? Edit this page on Github!

Ready to get started?

Install Front MatterLearn more

Special thanks to our backers & sponsors

run.events - Event Management PlatformNetlifyBEJS Community
Contributors
Dennis ZomaPatrick Kollitschmayumihara