Documentation Index Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt
Use this file to discover all available pages before exploring further.
Definition Assembly: Mintlify.Core.dllNamespace: Mintlify.CoreInheritance: System.ObjectSyntax Mintlify . Core . DocsJsonManager
Summary Loads and manages Mintlify docs.json configuration files with navigation manipulation capabilities.
This class provides comprehensive support for loading, validating, and modifying Mintlify
documentation configuration files. It handles serialization using the standard Mintlify
JSON options and provides APIs for navigation manipulation.
Constructors Initializes a new instance of the DocsJsonManager class.
Syntax public DocsJsonManager ( Mintlify . Core . DocsJsonValidator validator = null )
Parameters Name Type Description validatorMintlify.Core.DocsJsonValidator?The validator to use for validating configurations. If null, a new instance will be created.
Initializes a new instance of the DocsJsonManager class with the specified file path.
Syntax public DocsJsonManager ( string filePath , Mintlify . Core . DocsJsonValidator validator = null )
Parameters Name Type Description filePathstringThe path to the docs.json file to load. validatorMintlify.Core.DocsJsonValidator?The validator to use for validating configurations. If null, a new instance will be created.
Exceptions Exception Description ArgumentExceptionThrown when the file path does not exist or is not a JSON file.
Inherited Syntax Properties Gets the loaded Mintlify documentation configuration.
Syntax public Mintlify . Core . Models . DocsJsonConfig Configuration { get ; internal set ; }
Property Value Type: Mintlify.Core.Models.DocsJsonConfig?
The DocsJsonConfig instance loaded from the file system or string content.
Returns null if no configuration has been loaded or if loading failed.
Gets the collection of configuration loading errors encountered during processing.
Syntax public System . Collections . Generic . List < System . CodeDom . Compiler . CompilerError > ConfigurationErrors { get ; private set ; }
Property Value Type: System.Collections.Generic.List<System.CodeDom.Compiler.CompilerError>
A collection of CompilerError instances representing validation errors,
parsing failures, or other issues encountered during configuration loading.
Gets the file path of the loaded docs.json configuration file.
Syntax public string FilePath { get ; private set ; }
Property Value Type: string?
The full path to the docs.json file that was loaded. Returns null if the configuration
was loaded from string content rather than a file.
Gets a value indicating whether the configuration has been successfully loaded.
Syntax public bool IsLoaded { get ; }
Property Value Type: bool
True if the configuration was loaded without errors; otherwise, false.
Methods Adds a navigation item (page or group) to the specified collection, tracking paths appropriately.
Syntax public bool AddNavigationItem ( System . Collections . Generic . List < object > pages , object item )
Parameters Name Type Description pagesSystem.Collections.Generic.List<object>The pages collection to add to. itemobjectThe item to add (string page path or GroupConfig).
Returns Type: bool
True if the item was added; false if it was skipped (duplicate).
Adds a page to the navigation structure if it doesn’t already exist.
Syntax public bool AddPage ( System . Collections . Generic . List < object > pages , string pagePath , bool allowDuplicatePaths = false , bool updateKnownPaths = true )
Parameters Name Type Description pagesSystem.Collections.Generic.List<object>The pages collection to add to. pagePathstringThe page path to add. allowDuplicatePathsboolIf true, allows adding duplicate paths; otherwise, skips if the path already exists. updateKnownPathsboolIf true, updates the known page paths tracking; otherwise, only adds to the pages collection.
Returns Type: bool
True if the page was added; false if it already existed and duplicates are not allowed.
Adds a page to a hierarchical group path (slash-separated) in the navigation structure.
Syntax public bool AddPage ( string groupPath , string pagePath , bool allowDuplicatePaths = false )
Parameters Name Type Description groupPathstringThe hierarchical group path (e.g., “Getting Started/API Reference”). pagePathstringThe page path to add. allowDuplicatePathsboolIf true, allows adding duplicate paths; otherwise, skips if the path already exists.
Returns Type: bool
True if the page was added; false if it already existed and duplicates are not allowed.
Exceptions Exception Description InvalidOperationExceptionThrown when no configuration is loaded.
Adds a page to a group if it doesn’t already exist.
Syntax public bool AddPageToGroup ( Mintlify . Core . Models . GroupConfig group , string pagePath , bool allowDuplicatePaths = false , bool updateKnownPaths = true )
Parameters Name Type Description groupMintlify.Core.Models.GroupConfigThe group to add the page to. pagePathstringThe page path to add. allowDuplicatePathsboolIf true, allows adding duplicate paths; otherwise, skips if the path already exists. updateKnownPathsboolIf true, updates the known page paths tracking; otherwise, only adds to the pages collection.
Returns Type: bool
True if the page was added; false if it already existed and duplicates are not allowed.
Applies default values to missing configuration properties.
Syntax public void ApplyDefaults ( string name = null , string theme = "mint" )
Parameters Name Type Description namestring?The name to use for the documentation site if not already set. themestringThe theme to use if not already set (defaults to “mint”).
Exceptions Exception Description InvalidOperationExceptionThrown when no configuration is loaded.
Applies a URL prefix to all page references in the navigation structure.
Syntax public void ApplyUrlPrefix ( string prefix )
Parameters Name Type Description prefixstringThe prefix to apply to all URLs.
Exceptions Exception Description ArgumentExceptionThrown when prefix is null or whitespace. InvalidOperationExceptionThrown when no configuration is loaded.
This method recursively traverses the entire navigation structure and prepends the
specified prefix to all page URLs, href attributes, and root paths. The prefix is
normalized to ensure proper URL formatting (e.g., trailing slashes are handled).
Creates a default Mintlify documentation configuration with basic structure.
Syntax public static Mintlify . Core . Models . DocsJsonConfig CreateDefault ( string name , string theme = "mint" )
Parameters Name Type Description namestringThe name of the documentation site. themestringThe theme to use for the documentation site.
Returns Type: Mintlify.Core.Models.DocsJsonConfig
A new DocsJsonConfig instance with default values.
Exceptions Exception Description ArgumentExceptionThrown when name is null or whitespace.
Inherited Virtual Syntax public virtual bool Equals ( object obj )
Parameters Name Type Description objobject?-
Returns Type: bool
Inherited Syntax public static bool Equals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Finds or creates a group with the specified name in the pages collection.
Syntax public Mintlify . Core . Models . GroupConfig FindOrCreateGroup ( System . Collections . Generic . List < object > pages , string groupName )
Parameters Name Type Description pagesSystem.Collections.Generic.List<object>The pages collection to search/add to. groupNamestringThe name of the group to find or create.
Returns Type: Mintlify.Core.Models.GroupConfig
The existing or newly created group.
Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Inherited Syntax public System . Type GetType ()
Returns Type: System.Type
Checks if a page path is already known (tracked for duplicate prevention).
Syntax public bool IsPathKnown ( string pagePath )
Parameters Name Type Description pagePathstringThe page path to check.
Returns Type: bool
True if the path is already known; otherwise, false.
Loads and parses the docs.json file from the file path specified in the constructor.
Syntax Exceptions Exception Description InvalidOperationExceptionThrown when no file path has been specified.
Loads and parses the docs.json configuration from the specified string content.
Syntax public void Load ( string content )
Parameters Name Type Description contentstringThe JSON content to parse as a docs.json configuration.
Exceptions Exception Description ArgumentExceptionThrown when content is null or whitespace.
Loads the specified configuration and applies validation and cleaning steps.
Syntax public void Load ( Mintlify . Core . Models . DocsJsonConfig config )
Parameters Name Type Description configMintlify.Core.Models.DocsJsonConfigThe configuration object to load. Cannot be null.
This method replaces any existing configuration and clears previous configuration
errors. After loading, the configuration is validated and navigation groups are cleaned to ensure
consistency.
Inherited Syntax protected internal object MemberwiseClone ()
Returns Type: object
Merges another docs.json configuration into the current configuration.
Syntax public void Merge ( Mintlify . Core . Models . DocsJsonConfig other , bool combineBaseProperties = true , Mintlify . Core . Models . MergeOptions options = null )
Parameters Name Type Description otherMintlify.Core.Models.DocsJsonConfigThe configuration to merge into the current one. combineBasePropertiesboolIf true, merges base properties; if false, only merges navigation. optionsMintlify.Core.Models.MergeOptions?Optional merge options to control merge behavior. When null, default behavior is used.
Exceptions Exception Description ArgumentNullExceptionThrown when other is null. InvalidOperationExceptionThrown when no configuration is loaded.
This method performs a shallow merge, with the other configuration taking precedence
for non-null values. Navigation structures are combined intelligently.
Merges navigation from another NavigationConfig into the current configuration’s navigation.
Syntax public void MergeNavigation ( Mintlify . Core . Models . NavigationConfig sourceNavigation , Mintlify . Core . Models . MergeOptions options = null )
Parameters Name Type Description sourceNavigationMintlify.Core.Models.NavigationConfigThe navigation configuration to merge from. optionsMintlify.Core.Models.MergeOptions?Optional merge options to control merge behavior.
Exceptions Exception Description ArgumentNullExceptionThrown when sourceNavigation is null. InvalidOperationExceptionThrown when no configuration is loaded.
This method intelligently merges navigation structures, combining groups with the same name
and deduplicating page references. Use the MergeOptions parameter to control specific
behaviors like how empty groups are handled.
Merges navigation from an existing docs.json file into the current configuration.
Syntax public void MergeNavigation ( string filePath , Mintlify . Core . Models . MergeOptions options = null )
Parameters Name Type Description filePathstringThe path to the docs.json file containing navigation to merge. optionsMintlify.Core.Models.MergeOptions?Optional merge options to control merge behavior.
Exceptions Exception Description ArgumentExceptionThrown when filePath is null or whitespace. InvalidOperationExceptionThrown when no configuration is loaded. FileNotFoundExceptionThrown when the specified file does not exist.
This method loads navigation from an external docs.json file and merges it into the
current configuration. Only the navigation structure is merged; other configuration
properties are not affected.
Populates the navigation structure from a directory path by scanning for MDX files.
Syntax public void PopulateNavigationFromPath ( string path , string [] fileExtensions = null , bool includeApiReference = false , bool preserveExisting = true , bool allowDuplicatePaths = false , string [] excludeDirectories = null )
Parameters Name Type Description pathstringThe directory path to scan for documentation files. fileExtensionsstring[]?The file extensions to include (defaults to .mdx only). includeApiReferenceboolWhether to include the ‘api-reference’ directory in discovery (defaults to false). preserveExistingboolWhether to preserve existing navigation structure and merge discovered content (defaults to true). allowDuplicatePathsboolIf true, allows adding duplicate paths; otherwise, skips duplicates. excludeDirectoriesstring[]?Optional array of directory names to exclude from navigation discovery (e.g., DocumentationReference output directories).
Exceptions Exception Description ArgumentExceptionThrown when path is null or whitespace. InvalidOperationExceptionThrown when no configuration is loaded. DirectoryNotFoundExceptionThrown when the specified path does not exist.
This method scans the specified directory recursively and builds a navigation structure
based on the folder hierarchy and MDX files found. The method includes several advanced features:
The method preserves the directory structure in the navigation while applying these intelligent
processing rules to create clean, organized documentation.
Inherited Syntax public static bool ReferenceEquals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Saves the current configuration to the file system using the original file path.
Syntax Exceptions Exception Description InvalidOperationExceptionThrown when no configuration is loaded or no file path is specified.
Saves the current configuration to the specified file path.
Syntax public void Save ( string filePath )
Parameters Name Type Description filePathstringThe file path where the configuration should be saved.
Exceptions Exception Description ArgumentExceptionThrown when filePath is null or whitespace. InvalidOperationExceptionThrown when no configuration is loaded.
Inherited Virtual Syntax public virtual string ToString ()
Returns Type: string? 
