Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
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.Constructors
.ctor
Syntax
Properties
Canonical
Gets or sets the canonical URL for SEO.Syntax
Property Value
Type:string
Remarks
Helps prevent duplicate content issues by specifying the canonical version of the page.Classes
Gets or sets custom CSS classes for the page.Syntax
Property Value
Type:System.Collections.Generic.List<string>
Remarks
Additional CSS classes to apply to the page for custom styling.Data
Gets or sets custom data attributes.Syntax
Property Value
Type:System.Collections.Generic.Dictionary<string, string>
Remarks
Custom data attributes to add to the page for analytics or custom JavaScript.Deprecated
Gets or sets a value indicating whether the page is deprecated.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
When true, displays a deprecation notice on the page.Description
Gets or sets the description of the page.Syntax
Property Value
Type:string
Remarks
Used for SEO meta descriptions and page summaries.Groups
Gets or sets the groups that can access this page.Syntax
Property Value
Type:System.Collections.Generic.List<string>
Remarks
Used for access control in authenticated documentation sites.Hidden
Gets or sets a value indicating whether the page should be hidden from navigation.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
When true, the page is accessible by direct URL but not shown in navigation menus.Icon
Gets or sets the icon for the page.Syntax
Property Value
Type:string
Remarks
Can be a FontAwesome icon name, Lucide icon name, or a custom icon path. Examples: “cube”, “book”, “settings”, “star”.IconType
Gets or sets the icon type.Syntax
Property Value
Type:string
Remarks
Specifies the icon style. Common values: “solid”, “regular”, “light”, “duotone”.Meta
Gets or sets additional meta tags for the page.Syntax
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.Mode
Gets or sets the layout mode for the page.Syntax
Property Value
Type:string
Remarks
Controls the page layout. Common values: “wide”, “centered”.OgDescription
Gets or sets the OpenGraph description.Syntax
Property Value
Type:string
Remarks
Description used when the page is shared on social media platforms.OgImage
Gets or sets the OpenGraph image URL.Syntax
Property Value
Type:string
Remarks
Image used when the page is shared on social media platforms.OgTitle
Gets or sets the OpenGraph title.Syntax
Property Value
Type:string
Remarks
Title used when the page is shared on social media platforms.Order
Gets or sets the navigation order.Syntax
Property Value
Type:System.Nullable<int>
Remarks
Numeric value to control the order of pages in navigation. Lower numbers appear first.Public
Gets or sets a value indicating whether the page is public.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
Controls visibility in public documentation sites.Robots
Gets or sets the robots meta tag content.Syntax
Property Value
Type:string
Remarks
Controls search engine indexing. Common values: “index,follow”, “noindex,nofollow”.SidebarTitle
Gets or sets the sidebar title.Syntax
Property Value
Type:string
Remarks
Shorter title used in the sidebar navigation. If not specified, the main title is used.Tag
Gets or sets the tag for the page.Syntax
Property Value
Type:string
Remarks
Displays a tag badge next to the title. Common values: “NEW”, “BETA”, “DEPRECATED”.Title
Gets or sets the title of the page.Syntax
Property Value
Type:string
Remarks
This is the main heading displayed at the top of the page and used in navigation.Url
Gets or sets the external URL for the page.Syntax
Property Value
Type:string
Remarks
If specified, clicking on this page in navigation will redirect to this URL instead of showing content.Version
Gets or sets the version for the page.Syntax
Property Value
Type:string
Remarks
Used for version-specific documentation.Methods
Create
Creates a FrontMatterConfig with basic title and description, properly escaped.Syntax
Parameters
Name | Type | Description |
---|---|---|
title | string | The page title. |
description | string? | The page description. |
Returns
Type:Mintlify.Core.Models.FrontMatterConfig
A new FrontMatterConfig instance.
EscapeYamlValue
Escapes a value for safe use in YAML frontmatter.Syntax
Parameters
Name | Type | Description |
---|---|---|
value | string | The value to escape. |
Returns
Type:string
The escaped value, properly quoted if necessary.
ToYaml
Generates YAML frontmatter from this configuration.Syntax
Returns
Type:string
The YAML frontmatter as a string, including delimiters.