Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents a version configuration for global navigation in the Mintlify documentation site.Remarks
This configuration defines a version option that appears globally across all sections and pages, allowing users to switch between different versions of the documentation.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Default
Gets or sets whether this version is the default version for the documentation.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
When true, this version will be selected by default when users first visit the documentation. Only one version should be marked as default.Hidden
Gets or sets whether this version option is hidden by default.Syntax
Property Value
Type:System.Nullable<bool>
Remarks
When true, this version option will not be visible in the version selector unless specifically shown. This can be useful for versions that are deprecated, in development, or not ready for public access.Href
Gets or sets the URL or path for this version of the documentation.Syntax
Property Value
Type:string?
Remarks
Specifies where users should be directed when they select this version. Can be a relative path (e.g., “/v2/”) or an absolute URL for a different domain (e.g., “https://v2.docs.example.com/”).Version
Gets or sets the version identifier or name.Syntax
Property Value
Type:string
Remarks
Specifies the version name that will be displayed to users, such as “v1.0”, “v2.0”, “latest”, “beta”, or any descriptive version label. This should be concise and meaningful to your users. This is a required field.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
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
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?