Skip to main content

​
OverrideContentLoader

Loads override content and conceptual documentation for API types.

​
Syntax

public class OverrideContentLoader

​
Inheritance

​
Constructors

​
OverrideContentLoader

public OverrideContentLoader(MintlifyOptions options)
Initializes a new instance of the OverrideContentLoader class.

​
Parameters

​
Methods

​
LoadAllOverrideContentAsync

public Task<Dictionary<string, OverrideContent>> LoadAllOverrideContentAsync()
Loads all override content from the overrides directory.

​
Returns

Task<Dictionary<string, OverrideContent>> A dictionary of UID to override content.

​
LoadConceptualContentAsync

public Task<ConceptualContent> LoadConceptualContentAsync(DocFxApiItem typeItem, OverrideContent overrideContent)
Loads conceptual content for a specific type based on override file references.

​
Parameters

  • typeItem DocFxApiItem: The type item to load conceptual content for.
  • overrideContent OverrideContent: The override content that may reference conceptual files.

​
Returns

Task<ConceptualContent> The conceptual content.

​
LoadOverrideContentAsync

public Task<OverrideContent> LoadOverrideContentAsync(DocFxApiItem typeItem)
Loads override content for a specific type.

​
Parameters

  • typeItem DocFxApiItem: The type item to load overrides for.

​
Returns

Task<OverrideContent> The override content if found; otherwise, null.

​
Remarks

This class handles loading override YAML files that specify custom frontmatter and additional content, as well as loading the actual conceptual documentation files referenced in the overrides.
⌘I