DotNetDocs.Core

DotNetDocs.Core

The core documentation generation engine for DotNetDocs that transforms .NET assemblies and XML Doc Comments into rich, multi-format documentation.

Features

• Assembly Extraction: Leverages Roslyn to extract API metadata from compiled assemblies
• XML Documentation Processing: Parses and integrates XML documentation comments
• Conceptual Documentation: Enriches API docs with conceptual content from .mdz files
• Extensible Pipeline: Modular architecture with enrichers, transformers, and renderers
• Multi-Assembly Support: Merge documentation from multiple assemblies
• Multiple Output Formats: Built-in renderers for Markdown, JSON, and YAML

Installation

dotnet add package DotNetDocs.Core

Quick Start

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

var host = Host.CreateDefaultBuilder()
    .ConfigureServices((context, services) =>
    {
        services.AddDotNetDocs(ctx =>
        {
            ctx.DocumentationRootPath = "docs";
            ctx.ApiReferencePath = "api-reference";
        });
    })
    .Build();

using (var scope = host.Services.CreateScope())
{
    var manager = scope.ServiceProvider.GetRequiredService<DocumentationManager>();
    await manager.ProcessAsync("MyLibrary.dll", "MyLibrary.xml");
}

See Also

• Full Documentation - Complete guides, API reference, and examples
• DotNetDocs CLI - Get up and running fast with our easy CLI
• DotNetDocs.Sdk - MSBuild SDK for .docsproj projects
• DotNetDocs.Mintlify - Enhanced Mintlify.com support

Requirements

• .NET 8.0+, .NET 9.0+, or .NET 10.0+

License

MIT License - see LICENSE for details.