> ## Documentation Index
> Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FrontMatterConfig

> Represents frontmatter configuration for Mintlify documentation pages.

## Definition

**Assembly:** Mintlify.Core.dll

**Namespace:** Mintlify.Core.Models

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
Mintlify.Core.Models.FrontMatterConfig
```

## Summary

Represents frontmatter configuration for Mintlify documentation pages.

## Remarks

This class contains all the documented frontmatter properties supported by Mintlify.
These properties control page appearance, navigation, and behavior in the Mintlify documentation site.
For more information, see the Mintlify documentation at [https://mintlify.com/docs/content/overview](https://mintlify.com/docs/content/overview).

## Constructors

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor

#### Syntax

```csharp theme={"dark"}
public FrontMatterConfig()
```

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Canonical

Gets or sets the canonical URL for SEO.

#### Syntax

```csharp theme={"dark"}
public string Canonical { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Helps prevent duplicate content issues by specifying the canonical version of the page.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Classes

Gets or sets custom CSS classes for the page.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<string> Classes { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.List<string>`

#### Remarks

Additional CSS classes to apply to the page for custom styling.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Data

Gets or sets custom data attributes.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.Dictionary<string, string> Data { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.Dictionary<string, string>`

#### Remarks

Custom data attributes to add to the page for analytics or custom JavaScript.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Deprecated

Gets or sets a value indicating whether the page is deprecated.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<bool> Deprecated { get; set; }
```

#### Property Value

Type: `System.Nullable<bool>`

#### Remarks

When true, displays a deprecation notice on the page.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Description

Gets or sets the description of the page.

#### Syntax

```csharp theme={"dark"}
public string Description { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Used for SEO meta descriptions and page summaries.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Groups

Gets or sets the groups that can access this page.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<string> Groups { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.List<string>`

#### Remarks

Used for access control in authenticated documentation sites.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Hidden

Gets or sets a value indicating whether the page should be hidden from navigation.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<bool> Hidden { get; set; }
```

#### Property Value

Type: `System.Nullable<bool>`

#### Remarks

When true, the page is accessible by direct URL but not shown in navigation menus.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Icon

Gets or sets the icon for the page.

#### Syntax

```csharp theme={"dark"}
public string Icon { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Can be a FontAwesome icon name, Lucide icon name, or a custom icon path.
Examples: "cube", "book", "settings", "star".

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IconType

Gets or sets the icon type.

#### Syntax

```csharp theme={"dark"}
public string IconType { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Specifies the icon style. Common values: "solid", "regular", "light", "duotone".

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Meta

Gets or sets additional meta tags for the page.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.Dictionary<string, string> Meta { get; set; }
```

#### Property Value

Type: `System.Collections.Generic.Dictionary<string, string>`

#### Remarks

Dictionary of additional meta tag name/content pairs for custom SEO or social media tags.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Mode

Gets or sets the layout mode for the page.

#### Syntax

```csharp theme={"dark"}
public string Mode { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Controls the page layout. Common values: "wide", "centered".

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OgDescription

Gets or sets the OpenGraph description.

#### Syntax

```csharp theme={"dark"}
public string OgDescription { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Description used when the page is shared on social media platforms.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OgImage

Gets or sets the OpenGraph image URL.

#### Syntax

```csharp theme={"dark"}
public string OgImage { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Image used when the page is shared on social media platforms.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OgTitle

Gets or sets the OpenGraph title.

#### Syntax

```csharp theme={"dark"}
public string OgTitle { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Title used when the page is shared on social media platforms.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Order

Gets or sets the navigation order.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<int> Order { get; set; }
```

#### Property Value

Type: `System.Nullable<int>`

#### Remarks

Numeric value to control the order of pages in navigation. Lower numbers appear first.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Public

Gets or sets a value indicating whether the page is public.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<bool> Public { get; set; }
```

#### Property Value

Type: `System.Nullable<bool>`

#### Remarks

Controls visibility in public documentation sites.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Robots

Gets or sets the robots meta tag content.

#### Syntax

```csharp theme={"dark"}
public string Robots { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Controls search engine indexing. Common values: "index,follow", "noindex,nofollow".

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SidebarTitle

Gets or sets the sidebar title.

#### Syntax

```csharp theme={"dark"}
public string SidebarTitle { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Shorter title used in the sidebar navigation. If not specified, the main title is used.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Tag

Gets or sets the tag for the page.

#### Syntax

```csharp theme={"dark"}
public string Tag { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Displays a tag badge next to the title. Common values: "NEW", "BETA", "DEPRECATED".

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Title

Gets or sets the title of the page.

#### Syntax

```csharp theme={"dark"}
public string Title { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

This is the main heading displayed at the top of the page and used in navigation.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Url

Gets or sets the external URL for the page.

#### Syntax

```csharp theme={"dark"}
public string Url { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

If specified, clicking on this page in navigation will redirect to this URL instead of showing content.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Version

Gets or sets the version for the page.

#### Syntax

```csharp theme={"dark"}
public string Version { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

Used for version-specific documentation.

## Methods

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Create

Creates a FrontMatterConfig with basic title and description, properly escaped.

#### Syntax

```csharp theme={"dark"}
public static Mintlify.Core.Models.FrontMatterConfig Create(string title, string description = null)
```

#### Parameters

| Name          | Type      | Description           |
| ------------- | --------- | --------------------- |
| `title`       | `string`  | The page title.       |
| `description` | `string?` | The page description. |

#### Returns

Type: `Mintlify.Core.Models.FrontMatterConfig`
A new FrontMatterConfig instance.

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name  | Type      | Description |
| ----- | --------- | ----------- |
| `obj` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> EscapeYamlValue

Escapes a value for safe use in YAML frontmatter.

#### Syntax

```csharp theme={"dark"}
public static string EscapeYamlValue(string value)
```

#### Parameters

| Name    | Type     | Description          |
| ------- | -------- | -------------------- |
| `value` | `string` | The value to escape. |

#### Returns

Type: `string`
The escaped value, properly quoted if necessary.

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToYaml

Generates YAML frontmatter from this configuration.

#### Syntax

```csharp theme={"dark"}
public string ToYaml()
```

#### Returns

Type: `string`
The YAML frontmatter as a string, including delimiters.