Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models

Syntax

Summary

Represents an SDK documentation artifact used to auto-populate reference pages.

Remarks

Declare sdk on a tab or a group. Mintlify reads the artifact and generates navigation groups and pages for every class, interface, module, and function. format is typedoc, docfx, javadoc, sphinx, phpdoc, or go. SdkRefConfig.Source is a relative path or HTTPS URL (HTTP is not accepted). SdkRefConfig.Directory defaults to sdk-reference. Nested groups inherit the parent sdk unless they set their own. See https://www.mintlify.com/docs/api-playground/sdk-reference-setup.

Examples

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Directory

Gets or sets the URL path prefix for generated pages.

Syntax

Property Value

Type: string?

Remarks

Defaults to sdk-reference. Use a unique prefix for each library to avoid route collisions.

Format

Gets or sets the documentation generator that produced the artifact.

Syntax

Property Value

Type: string?

Remarks

Valid values are typedoc, docfx, javadoc, sphinx, phpdoc, and go.

Source

Gets or sets the relative path or HTTPS URL of the generator artifact.

Syntax

Property Value

Type: string?

Remarks

Directory-shaped formats such as DocFX, Javadoc, and Sphinx accept a zip (or a Javadoc jar) when the source is remote.

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?