Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
title: Front matter
metaDescription: Supported front matter variables.
search: false
tocDepth: 3
---

<TopBlock></TopBlock>

## <inlinecode>title</inlinecode>
## Required

### <inlinecode>title</inlinecode>

The `<h1>` title of the page. This title appears at the top of the page, and in the left-hand navigation.

Expand All @@ -17,7 +20,7 @@ Note:
- You can wrap the `title` text in single quotes, but this is not mandatory.
- If you wrap the `title` text in single quotes, then you cannot include apostrophes in the text.

## <inlinecode>metaTitle</inlinecode>
### <inlinecode>metaTitle</inlinecode>

The `<title>` of the page - falls back to `title` (`h1`).

Expand All @@ -30,11 +33,13 @@ Note:
- You can wrap the `metaTitle` text in single quotes, but this is not mandatory.
- If you wrap the `metaTitle` text in single quotes, then you cannot include apostrophes in the text.

## <inlinecode>navTitle</inlinecode>
## Optional

### <inlinecode>navTitle</inlinecode>

Specifies a different, usually shorter title for the left-hand navigation.

## <inlinecode>metaDescription</inlinecode>
### <inlinecode>metaDescription</inlinecode>

The `<meta name="description" content="" />` of the page.

Expand All @@ -43,29 +48,35 @@ Note:
- You can wrap the `metaDescription` text in single quotes, but this is not mandatory.
- If you wrap the `metaDescription` text in single quotes, then you cannot include apostrophes in the text.

## <inlinecode>staticLink</inlinecode>
### <inlinecode>staticLink</inlinecode>

Accepts `true` or `false` (defaults to `false`).

If `true`, this option turns the page into a heading in the left-hand navigation. This heading cannot be clicked by the docs user. For example: https://www.prisma.io/docs/concepts/overview

> **Note**: The page still exists, but docs users can only navigate to it with the breadcrumb trail. We recommend that you add a [subsections](/about/prisma-docs/docs-components/mdx-examples#subsections) MDX component to the page, so that it contains useful content when a user navigates to it with the breadcrumb trail.
Note:

- The page still exists, but docs users can only navigate to it with the breadcrumb trail. We recommend that you add a [subsections](/about/prisma-docs/docs-components/mdx-examples#subsections) MDX component to the page, so that it contains useful content when a user navigates to it with the breadcrumb trail.

## <inlinecode>preview</inlinecode>
### <inlinecode>preview</inlinecode>

Accepts `true` or `false` (defaults to `false`).

Adds a `preview` label to a page in the left-hand navigation.

## <inlinecode>toc</inlinecode>
### <inlinecode>toc</inlinecode>

Enable or disable table of contents navigation on the page (defaults to `false`). For example:
Enable or disable table of contents navigation on the page (defaults to `true`). For example:

```
toc: true
```

## <inlinecode>tocDepth</inlinecode>
Note:

- Requires to also customize `tocDepth` to have any visible effect.

### <inlinecode>tocDepth</inlinecode>

Controls the depth of headings to show in the in-page ToC:

Expand All @@ -75,7 +86,7 @@ tocDepth: 2

> **Note**: Currently defaults up to level - `h2`

## <inlinecode>hidePage</inlinecode>
### <inlinecode>hidePage</inlinecode>

Accepts `true` or `false` (defaults to `false`).

Expand All @@ -90,7 +101,7 @@ Note:
- A page hidden with `hidePage` is not listed by the [subsections](/about/prisma-docs/docs-components/mdx-examples#subsections) MDX component.
- A page hidden with `hidePage` is still findable by docs users with a search. To omit a page from the search results, use the [`search`](#search) tag.

## <inlinecode>search</inlinecode>
### <inlinecode>search</inlinecode>

Accepts `true` or `false` (defaults to `true`).

Expand Down