Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents a language configuration for global navigation in the Mintlify documentation site.Remarks
This configuration defines a language option that appears globally across all sections and pages, allowing users to switch between different language versions of the documentation.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Default
Gets or sets whether this language is the default language for the documentation.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
When true, this language will be selected by default when users first visit the documentation. Only one language should be marked as default.Hidden
Gets or sets whether this language option is hidden by default.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
When true, this language option will not be visible in the language selector unless specifically shown. This can be useful for languages that are in development or not ready for public access.Href
Gets or sets the URL or path for this language version.Syntax
Property Value
Type:string?
Remarks
Specifies where users should be directed when they select this language. Can be a relative path (e.g., “/es/”) or an absolute URL for a different domain (e.g., “https://es.example.com/”).Language
Gets or sets the language code in ISO 639-1 format.Syntax
Property Value
Type:string
Remarks
Specifies the language using a standard two-letter code such as “en” for English, “es” for Spanish, “fr” for French, etc. Extended codes like “zh-Hans” for Simplified Chinese or “fr-CA” for Canadian French are also supported. This is a required field.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?