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

# MintlifyOptions

> Configuration options for Mintlify documentation generation.

## Definition

**Assembly:** Mintlify.Core.dll

**Namespace:** Mintlify.Core

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
Mintlify.Core.MintlifyOptions
```

## Summary

Configuration options for Mintlify documentation generation.

## Remarks

This class contains all the configuration settings that control how the Mintlify
documentation is generated, including output paths, filtering options, and formatting preferences.

## Constructors

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor

#### Syntax

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

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> AppearanceDefault

Gets or sets the default appearance mode (system, light, dark).

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> AppearanceStrict

Gets or sets whether to hide the light/dark mode toggle.

#### Syntax

```csharp theme={"dark"}
public bool AppearanceStrict { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> BaseUrl

Gets or sets the base URL for cross-references to external documentation.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Clean

Gets or sets whether to clean the output directory before generating.

#### Syntax

```csharp theme={"dark"}
public bool Clean { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ConfigOnly

Gets or sets whether to only generate the docs.json file without MDX files.

#### Syntax

```csharp theme={"dark"}
public bool ConfigOnly { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> FaviconDark

Gets or sets the dark mode favicon path.

#### Syntax

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

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> FaviconLight

Gets or sets the favicon path or light mode favicon.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ForceBuild

Gets or sets whether to force a rebuild instead of using existing binaries.

#### Syntax

```csharp theme={"dark"}
public bool ForceBuild { get; set; }
```

#### Property Value

Type: `bool`

#### Remarks

When false (default), DocFX will attempt to use existing compiled assemblies
for faster documentation generation. When true, forces a complete rebuild
which may be slower but ensures all dependencies are up to date.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GenerateConfig

Gets or sets whether to generate a docs.json configuration file.

#### Syntax

```csharp theme={"dark"}
public bool GenerateConfig { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GenerateNavigationFiles

Gets or sets whether to generate navigation.json files in non-api-reference folders.

#### Syntax

```csharp theme={"dark"}
public bool GenerateNavigationFiles { get; set; }
```

#### Property Value

Type: `bool`

#### Remarks

When true, the generator will create navigation.json files in directories that don't
already have them, preserving the auto-discovered navigation structure. This allows
users to customize navigation later without losing their changes during regeneration.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GitHubUrl

Gets or sets the GitHub URL for footer social links.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IconLibrary

Gets or sets the icon library to use (fontawesome, lucide).

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IncludeExamples

Gets or sets whether to include code examples in the generated documentation.

#### Syntax

```csharp theme={"dark"}
public bool IncludeExamples { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IncludeInheritance

Gets or sets whether to include inheritance information.

#### Syntax

```csharp theme={"dark"}
public bool IncludeInheritance { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IncludeInternal

Gets or sets whether to include internal members in the documentation.

#### Syntax

```csharp theme={"dark"}
public bool IncludeInternal { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IncludeSeeAlso

Gets or sets whether to include see also references.

#### Syntax

```csharp theme={"dark"}
public bool IncludeSeeAlso { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> LogoDark

Gets or sets the path to the dark logo file.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> LogoHref

Gets or sets the URL to redirect to when clicking the logo.

#### Syntax

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

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> LogoLight

Gets or sets the path to the light logo file.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MaxDepth

Gets or sets the maximum depth for nested type documentation.

#### Syntax

```csharp theme={"dark"}
public int MaxDepth { get; set; }
```

#### Property Value

Type: `int`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> NamespaceFilter

Gets or sets the namespace filter regex pattern.
Only namespaces matching this pattern will be included.

#### Syntax

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

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> OutputDirectory

Gets or sets the output directory for generated documentation.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> PreserveExistingConfig

Gets or sets whether to preserve existing docs.json configuration when updating.

#### Syntax

```csharp theme={"dark"}
public bool PreserveExistingConfig { get; set; }
```

#### Property Value

Type: `bool`

#### Remarks

When true (default), the generator will read any existing docs.json file and merge
the generated API documentation with existing configuration, preserving custom
navigation, styling, integrations, and other settings. When false, the generator
will completely replace the docs.json file with new configuration.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> PrimaryColor

Gets or sets the primary color for the documentation theme.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> PrimaryDarkColor

Gets or sets the primary color for dark mode.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SearchPrompt

Gets or sets the search prompt text.

#### Syntax

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

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SeoIndexing

Gets or sets the SEO indexing mode (navigable, all).

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SiteDescription

Gets or sets the description of the documentation site.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SiteName

Gets or sets the name of the documentation site.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> SolutionNamePrefix

Gets or sets the solution name prefix to strip from project names when generating paths.

#### Syntax

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

#### Property Value

Type: `string?`

#### Remarks

For example, if the solution is "CloudNimble.Breakdance" and projects are named
"CloudNimble.Breakdance.AspNetCore", the output path will be "/aspnetcore/" instead
of "/cloudnimble-breakdance-aspnetcore/".

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> StripBackticksAroundLinks

Gets or sets whether to strip backticks around parameter and return value links.

#### Syntax

```csharp theme={"dark"}
public bool StripBackticksAroundLinks { get; set; }
```

#### Property Value

Type: `bool`

#### Remarks

When true (default), removes backticks around markdown links in parameter descriptions
and return value documentation to ensure proper link rendering in Mintlify.
This fixes the issue where links inside code formatting don't render correctly.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Theme

Gets or sets the theme for the documentation site.

#### Syntax

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

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> TypeFilter

Gets or sets the type filter regex pattern.
Only types matching this pattern will be included.

#### Syntax

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

#### Property Value

Type: `string?`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Verbose

Gets or sets whether to enable verbose output during generation.

#### Syntax

```csharp theme={"dark"}
public bool Verbose { get; set; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> WebsiteUrl

Gets or sets the website URL for footer social links.

#### Syntax

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

#### Property Value

Type: `string`

## Methods

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Parameters

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

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Parameters

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

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Parameters

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

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

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

#### Returns

Type: `string?`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Validate

Validates the options and throws an exception if any are invalid.

#### Syntax

```csharp theme={"dark"}
public void Validate()
```