Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

Syntax

Summary

Represents the configuration for 404 (Not Found) error handling in the Mintlify documentation site.

Remarks

This configuration controls what happens when users try to access pages that don’t exist, including whether to automatically redirect them to the home page.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Description

Gets or sets a custom description for the 404 error page.

Syntax

Property Value

Type: string?

Remarks

When specified, this description appears below the title on the 404 page.

Redirect

Gets or sets whether to automatically redirect users to the home page when a 404 error occurs.

Syntax

Property Value

Type: System.Nullable<bool>?

Remarks

When true (default), users who navigate to non-existent pages will be automatically redirected to the home page of the documentation site. When false, users will see a standard 404 error page instead. Automatic redirection can improve user experience by keeping users within the documentation rather than showing error pages.

Title

Gets or sets a custom title for the 404 error page.

Syntax

Property Value

Type: string?

Remarks

When specified, this title replaces the default “Page not found” heading on the 404 page.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?