Skip to main content
N
1.0.0-beta41.0.0-beta6
TomsToolbox.Settings.Documentation.Builder package icon

TomsToolbox.Settings.Documentation.Builder

v1.0.0-beta5Pre-release
net8.0net10.0

Automatically generate comprehensive documentation for your .NET application configuration settings. Keep your 'appsettings.json' files documented, validated, and always up-to-date with JSON schemas, Markdown, and HTML documentation.

tom-englert
NuGetWebsiteLicenseCompare
Published
Jan 9, 2026
9mo ago
Total Downloads
1.5K
1,539

Install

dotnet add package TomsToolbox.Settings.Documentation.Builder --version 1.0.0-beta5
Download NuGet FileBrowse File Contents
ProductVersions
.NET
net10.0net8.0

README

TomsToolbox.Settings.Documentation.Builder

Automatically generate documentation for your .NET application configuration settings.

Overview

Settings.Documentation is a runtime library that scans your configuration classes and generates comprehensive documentation in multiple formats:

  • JSON Schema - Provides IntelliSense and validation in your appsettings.json files
  • Markdown - Human-readable documentation of all configuration options
  • HTML - Web-based documentation for easy sharing and viewing

The library can work with:

  • Classes decorated with [SettingsSection] attribute
  • Configuration options registered in IServiceCollection
  • Any custom type mapping strategy

Key Features

  • Automatically discovers configuration classes in your assemblies
  • Generates JSON schema files for IDE IntelliSense support
  • Creates Markdown and HTML documentation
  • Updates appsettings.json files with default values
  • Respects [SettingsIgnore] and [SettingsSecret] attributes
  • Configurable output formats and file locations
  • Supports multiple target frameworks (.NET 8.0, .NET 10.0)

Requirements

  • .NET 8.0 or .NET 10.0
  • Microsoft.Extensions.Configuration.Abstractions
  • Microsoft.Extensions.Options

Related Packages

  • TomsToolbox.Settings.Documentation.Abstractions - Attribute definitions for marking up configuration classes
  • TomsToolbox.Settings.Documentation.Analyzer - Roslyn analyzer for compile-time validation

For detailed usage instructions, see the main repository documentation.

License

MIT License

Part of the TomsToolbox library suite.

Changes from Previous Version

No structural changes between v1.0.0-beta4 and v1.0.0-beta5.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

This version is marked prerelease. Validate its API and upgrade path before production use.No SPDX license expression is published. Review the license text and your organisation's policy before redistribution.Compatibility metadata lists 2 target frameworks; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.

Audit NuGet dependencies in a .NET projectReview NuGet licenses before shipping