MintlifyOptions

Configuration options for Mintlify documentation generation.

Syntax

public class MintlifyOptions

Inheritance

Properties

AppearanceDefault

public string AppearanceDefault { get; set; }
Gets or sets the default appearance mode (system, light, dark).

Returns

string

AppearanceStrict

public bool AppearanceStrict { get; set; }
Gets or sets whether to hide the light/dark mode toggle.

Returns

bool

BaseUrl

public string BaseUrl { get; set; }
Gets or sets the base URL for cross-references to external documentation.

Returns

string

Clean

public bool Clean { get; set; }
Gets or sets whether to clean the output directory before generating.

Returns

bool

ConfigOnly

public bool ConfigOnly { get; set; }
Gets or sets whether to only generate the docs.json file without MDX files.

Returns

bool

FaviconDark

public string FaviconDark { get; set; }
Gets or sets the dark mode favicon path.

Returns

string

FaviconLight

public string FaviconLight { get; set; }
Gets or sets the favicon path or light mode favicon.

Returns

string

ForceBuild

public bool ForceBuild { get; set; }
Gets or sets whether to force a rebuild instead of using existing binaries.

Returns

bool

GenerateConfig

public bool GenerateConfig { get; set; }
Gets or sets whether to generate a docs.json configuration file.

Returns

bool

GitHubUrl

public string GitHubUrl { get; set; }
Gets or sets the GitHub URL for footer social links.

Returns

string

IconLibrary

public string IconLibrary { get; set; }
Gets or sets the icon library to use (fontawesome, lucide).

Returns

string

IncludeExamples

public bool IncludeExamples { get; set; }
Gets or sets whether to include code examples in the generated documentation.

Returns

bool

IncludeInheritance

public bool IncludeInheritance { get; set; }
Gets or sets whether to include inheritance information.

Returns

bool

IncludeInternal

public bool IncludeInternal { get; set; }
Gets or sets whether to include internal members in the documentation.

Returns

bool

IncludeSeeAlso

public bool IncludeSeeAlso { get; set; }
Gets or sets whether to include see also references.

Returns

bool

LogoDark

public string LogoDark { get; set; }
Gets or sets the path to the dark logo file.

Returns

string

LogoHref

public string LogoHref { get; set; }
Gets or sets the URL to redirect to when clicking the logo.

Returns

string

LogoLight

public string LogoLight { get; set; }
Gets or sets the path to the light logo file.

Returns

string

MaxDepth

public int MaxDepth { get; set; }
Gets or sets the maximum depth for nested type documentation.

Returns

int

NamespaceFilter

public string NamespaceFilter { get; set; }
Gets or sets the namespace filter regex pattern. Only namespaces matching this pattern will be included.

Returns

string

OutputDirectory

public string OutputDirectory { get; set; }
Gets or sets the output directory for generated documentation.

Returns

string

PreserveExistingConfig

public bool PreserveExistingConfig { get; set; }
Gets or sets whether to preserve existing docs.json configuration when updating.

Returns

bool

PrimaryColor

public string PrimaryColor { get; set; }
Gets or sets the primary color for the documentation theme.

Returns

string

PrimaryDarkColor

public string PrimaryDarkColor { get; set; }
Gets or sets the primary color for dark mode.

Returns

string

SearchPrompt

public string SearchPrompt { get; set; }
Gets or sets the search prompt text.

Returns

string

SeoIndexing

public string SeoIndexing { get; set; }
Gets or sets the SEO indexing mode (navigable, all).

Returns

string

SiteDescription

public string SiteDescription { get; set; }
Gets or sets the description of the documentation site.

Returns

string

SiteName

public string SiteName { get; set; }
Gets or sets the name of the documentation site.

Returns

string

SolutionNamePrefix

public string SolutionNamePrefix { get; set; }
Gets or sets the solution name prefix to strip from project names when generating paths.

Returns

string
public bool StripBackticksAroundLinks { get; set; }
Gets or sets whether to strip backticks around parameter and return value links.

Returns

bool

Theme

public string Theme { get; set; }
Gets or sets the theme for the documentation site.

Returns

string

TypeFilter

public string TypeFilter { get; set; }
Gets or sets the type filter regex pattern. Only types matching this pattern will be included.

Returns

string

Verbose

public bool Verbose { get; set; }
Gets or sets whether to enable verbose output during generation.

Returns

bool

WebsiteUrl

public string WebsiteUrl { get; set; }
Gets or sets the website URL for footer social links.

Returns

string

Methods

Validate

public void Validate()
Validates the options and throws an exception if any are invalid.

Remarks

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