Meziantou.DocumentationGenerator 0.10.3

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global Meziantou.DocumentationGenerator --version 0.10.3
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local Meziantou.DocumentationGenerator --version 0.10.3
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Meziantou.DocumentationGenerator&version=0.10.3
                    
nuke :add-package Meziantou.DocumentationGenerator --version 0.10.3
                    

Meziantou.DocumentationGenerator

Meziantou.DocumentationGenerator is a .NET tool that generates a fully static documentation site from NuGet packages and Markdown pages whose folder structure defines the navigation.

  • API reference generated from the public API of the packages (read as metadata, package code is never executed), with one page per type, member anchors, C# declarations, XML documentation, inherited documentation and links to the source code on GitHub.
  • Source packages (contentFiles/cs/**/*.cs) are documented too: their sources are compiled in memory and their internal types are shown as the consuming project sees them.
  • APIs of every target framework of a package on a single page, with availability per framework and declaration variants when frameworks differ.
  • Authored Markdown pages with front matter, tables, alerts, syntax highlighting and cref: links to APIs.
  • Plain HTML files that work on any static host, at the root of a domain or under a path such as /docs/. No .NET runtime, server or CDN is needed to browse the site; internal URLs are file-relative, so moving the site requires no rebuild. JavaScript only adds search, theme selection and conveniences.
  • Light, dark and system themes, responsive and accessible layout, collapsible table of contents (with the desktop preference remembered across pages), client-side search.

Requirements

  • The .NET 11 SDK (or runtime) to run the tool. While .NET 11 is in preview, install a preview SDK.
  • No requirement to browse the generated site.

Quick start

Install the tool in a local tool manifest:

dotnet new tool-manifest
dotnet tool install Meziantou.DocumentationGenerator

Create a configuration file and a docs directory:

dotnet Meziantou.DocumentationGenerator init --package Contoso.Json --package-version 2.1.0 --title "Contoso"

Generate the site in _site:

dotnet Meziantou.DocumentationGenerator build

Preview the site on http://localhost:8080, rebuilding it and reloading open pages when you edit the content:

dotnet Meziantou.DocumentationGenerator build --watch --serve

To install the tool globally instead, use dotnet tool install --global Meziantou.DocumentationGenerator and run Meziantou.DocumentationGenerator.

Minimal configuration

{
  "version": 1,
  "site": { "title": "Contoso" },
  "packages": [
    { "id": "Contoso.Json", "version": "2.1.0" }
  ],
  "content": { "root": "docs" }
}

The API reference is organized by namespace, merging the namespaces of every package; each package also has a page listing its namespaces. The docs directory contains Markdown pages; docs/index.md is the home page and the folder structure of docs defines the navigation.

Commands

Command Description
Meziantou.DocumentationGenerator init [directory] Creates docgen.json and docs/index.md. Existing Markdown files are never overwritten; --force overwrites docgen.json. Options: --package, --package-version, --title.
Meziantou.DocumentationGenerator build Generates the site. Options: --config (default docgen.json), --output, --base-path, --site-url, --offline, --no-source-links, --warnaserror, --verbosity quiet\|minimal\|normal\|detailed, --watch (rebuild when the configuration, content or local packages change), --serve (preview the site on a local web server; with --watch, open pages reload after each build), --port (default 8080, 0 picks a free port).
Meziantou.DocumentationGenerator --version, --help Displays the version or the help.

Every docgen.json option also has a build argument, such as --site-title, --content-root and --packages. See the command-line configuration reference or build --help. When the default docgen.json does not exist, configure the site entirely on the command line:

dotnet Meziantou.DocumentationGenerator build --content-root docs --site-title "Contoso" --allow-invalid-cref

--allow-invalid-cref makes unresolved and ambiguous API references warnings instead of errors, so you can check authored documentation without the packages. Their text is displayed without a link; other validation still applies.

Exit codes: 0 success, 1 build failed (nothing is published), 2 invalid command line, 130 cancelled. With --watch or --serve, the command runs until Ctrl+C and then exits with 0; without --watch, a failed build exits with 1 and the server is not started.

Documentation

Limitations

Versioned sites and version selectors, API diffs, full-text search, localization, custom themes and plugins, and complete DocFX compatibility are not supported. See architecture.md.

Building from source

The repository requires the .NET 11 SDK pinned in global.json.

dotnet build Meziantou.DocumentationGenerator.slnx
dotnet test --solution Meziantou.DocumentationGenerator.slnx
dotnet pack src/Meziantou.DocumentationGenerator/Meziantou.DocumentationGenerator.csproj --output artifacts/package
Product Compatible and additional computed target framework versions.
.NET net11.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
0.10.12 0 11/20/2026
0.10.11 0 11/20/2026
0.10.10 888 11/12/2026
0.10.9 605 11/8/2026
0.10.8 102 11/8/2026
0.10.7 97 11/8/2026
0.10.6 253 11/8/2026
0.10.5 879 11/1/2026
0.10.4 291 11/1/2026
0.10.3 131 10/31/2026
0.10.2 100 10/31/2026
0.10.1 113 10/31/2026
0.10.0 109 10/31/2026
0.9.5 100 10/31/2026
0.9.4 105 10/31/2026
0.9.3 132 10/31/2026
0.9.2 172 10/31/2026
0.9.1 118 10/31/2026
0.9.0 107 10/30/2026
0.8.0 141 10/30/2026
Loading failed