Logodocs.page

Frontmatter

Frontmatter is a way to customize metadata of a page directly within your Markdown files. The metadata properties can be added to Markdown pages by adding frontmatter blocks to the top of any page.

Example
---
title: Welcome to Awesome Project
description: Some awesome docs!
---

# Welcome!

Properties#

Below is a list of all available frontmatter properties, their type and default values.

title
string

The title of the page used in metadata (e.g. <title> and social cards).


description
string

The description of the page used in metadata.


image
string

The path (either absolute or relative to the /docs directory) to social preview card which will be displayed for this page.


redirect
string

A URL to redirect (301) the user to when they request this page. This has presedence over all other frontmatter.

---
redirect: /getting-started
redirect: https://github.com/acme/awesome-project
---
previous
string

A path which if set, will show a link to the previous page at the bottom of the page. Use with previousTitle:

---
previous: /getting-started
previousTitle: Getting started
---

next
string

A path which if set, will show a link to the next page at the bottom of the page. Use with nextTitle:

---
next: /getting-started
nextTitle: Getting started
---

noindexDefault: false
boolean

If true, the page will be excluded from search engines.