DotNetDocs.Core 1.0.0-preview.31

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of DotNetDocs.Core.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package DotNetDocs.Core --version 1.0.0-preview.31
                    


                    

                
NuGet\Install-Package DotNetDocs.Core -Version 1.0.0-preview.31
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="DotNetDocs.Core" Version="1.0.0-preview.31" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="DotNetDocs.Core" Version="1.0.0-preview.31" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DotNetDocs.Core" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add DotNetDocs.Core --version 1.0.0-preview.31
                    


                    

                
#r "nuget: DotNetDocs.Core, 1.0.0-preview.31"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package DotNetDocs.Core@1.0.0-preview.31
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=DotNetDocs.Core&version=1.0.0-preview.31&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DotNetDocs.Core&version=1.0.0-preview.31&prerelease
                    


                            Install as a Cake Tool

DotNetDocs.Core

NuGet Downloads License

<a href="https://dotnetdocs.com"> <img src="https://raw.githubusercontent.com/CloudNimble/DotNetDocs/refs/heads/dev/src/CloudNimble.DotNetDocs.Docs/images/logos/dotnetdocs.light.svg" alt="DotNetDocs Logo" width="450" /> </a>

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

Requirements

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

License

MIT License - see LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on DotNetDocs.Core:

Package Downloads
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.
DotNetDocs.Plugins.AI

Package Description
DotNetDocs.Plugins.GitHub

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0-preview.10 105 11/7/2025
1.1.0-preview.9 112 11/6/2025
1.1.0-preview.8 112 11/6/2025
1.1.0-preview.7 105 11/6/2025
1.1.0-preview.6 107 11/6/2025
1.1.0-preview.5 114 11/6/2025
1.1.0-preview.4 109 11/5/2025
1.1.0-preview.3 110 11/5/2025
1.1.0-preview.2 114 11/5/2025
1.1.0-preview.1 95 11/2/2025
1.0.3-preview.1 117 10/23/2025
1.0.2 161 10/23/2025
1.0.1 162 10/20/2025
1.0.1-preview.1 118 10/20/2025
1.0.0 83 10/18/2025
1.0.0-preview.32 35 10/18/2025
1.0.0-preview.31 117 10/16/2025
1.0.0-preview.30 118 10/15/2025
1.0.0-preview.29 122 10/13/2025
1.0.0-preview.28 118 10/13/2025
1.0.0-preview.27 108 10/12/2025
1.0.0-preview.26 91 10/10/2025
1.0.0-preview.25 94 10/10/2025
1.0.0-preview.24 111 10/5/2025
1.0.0-preview.23 101 10/3/2025
1.0.0-preview.22 99 10/3/2025
1.0.0-preview.21 102 9/28/2025
1.0.0-preview.20 129 9/24/2025
1.0.0-preview.19 257 9/16/2025
1.0.0-preview.18 253 9/16/2025
1.0.0-preview.17 242 9/15/2025
1.0.0-preview.16 201 9/15/2025
1.0.0-preview.15 171 9/14/2025
1.0.0-preview.14 99 9/14/2025
1.0.0-preview.13 100 9/13/2025
1.0.0-preview.12 100 9/13/2025
1.0.0-preview.11 51 9/13/2025
1.0.0-preview.10 83 9/5/2025
1.0.0-preview.9 128 9/5/2025
1.0.0-preview.8 131 9/3/2025
1.0.0-preview.7 128 9/1/2025
1.0.0-preview.6 125 9/1/2025
1.0.0-preview.5 145 8/30/2025
1.0.0-preview.4 168 8/29/2025
1.0.0-preview.3 173 8/29/2025
1.0.0-preview.2 168 8/28/2025
1.0.0-preview.1 168 8/27/2025