> ## Documentation Index
> Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SdkRefConfig

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

## Definition

**Assembly:** Mintlify.Core.dll

**Namespace:** Mintlify.Core.Models

## Syntax

```csharp theme={"dark"}
Mintlify.Core.Models.SdkRefConfig
```

## 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](https://dotnetdocs.com/api-reference/Mintlify/Core/Models/SdkRefConfig.md#source) is a relative path or HTTPS URL
(HTTP is not accepted). [SdkRefConfig.Directory](https://dotnetdocs.com/api-reference/Mintlify/Core/Models/SdkRefConfig.md#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](https://www.mintlify.com/docs/api-playground/sdk-reference-setup).

## Examples

```csharp theme={"dark"}
"tab": "TypeScript SDK",
"sdk": {
  "format": "typedoc",
  "source": "sdk-artifacts/typedoc.json",
  "directory": "sdk/typescript"
}
```

## Constructors

### &#x20;.ctor

#### Syntax

```csharp theme={"dark"}
public SdkRefConfig()
```

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### &#x20;Directory

Gets or sets the URL path prefix for generated pages.

#### Syntax

```csharp theme={"dark"}
public string Directory { get; set; }
```

#### Property Value

Type: `string?`

#### Remarks

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

### &#x20;Format

Gets or sets the documentation generator that produced the artifact.

#### Syntax

```csharp theme={"dark"}
public string Format { get; set; }
```

#### Property Value

Type: `string?`

#### Remarks

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

### &#x20;Source

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

#### Syntax

```csharp theme={"dark"}
public string Source { get; set; }
```

#### 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

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.