DotNetDocs.Mintlify

DotNetDocs.Mintlify

Extensions for DotNetDocs that transform your .NET XML Doc Comments into beautiful Mintlify websites with smart navigation, context-aware icons, and rich MDX features.

Features

• MDX with Frontmatter: Auto-generated frontmatter with icons, tags, SEO metadata, and keywords
• Smart Navigation: Automatic docs.json generation with hierarchical namespace organization
• Context-Aware Icons: 50+ FontAwesome icons automatically assigned based on type characteristics
• React Components: Embed custom React components directly in your MDX files
• Flexible Output Modes: Choose between File and Folder namespace organization

Installation

dotnet add package DotNetDocs.Mintlify

Quick Start

using CloudNimble.DotNetDocs.Core.Configuration;
using Microsoft.Extensions.DependencyInjection;

var builder = new DotNetDocsBuilder()
    .AddDefaultPipeline()
    .AddMintlifyRenderer(options =>
    {
        options.NavigationMode = NavigationMode.Unified;
        options.NamespaceMode = NamespaceMode.Folder;
        options.GenerateDocsJson = true;
        options.IncludeIcons = true;
    });

var result = await builder.BuildAsync();

Navigation Modes

• Unified: Single navigation tree with all namespaces (best for single-project solutions)
• ByAssembly: Separate groups per assembly (best for multi-project solutions)

Output Modes

• File Mode: One MDX file per namespace (simpler file structure)
• Folder Mode: Folder per namespace with separate type files (better for large projects)

Preview Your Docs

npm install -g mintlify
cd docs
mintlify dev

Your documentation will be available at http://localhost:3000.

See Also

• Full Documentation - Complete guides, examples, and icon reference
• DotNetDocs CLI - Get up and running fast with our easy CLI
• DotNetDocs.Core - Core documentation engine
• DotNetDocs.Sdk - MSBuild SDK for .docsproj projects
• Mintlify Documentation - Official Mintlify docs and component reference

Requirements

• .NET 8.0+, .NET 9.0+, or .NET 10.0+
• Mintlify CLI (for local preview)

License

MIT License - see LICENSE for details.