TomsToolbox.Settings.Documentation.Builder 1.1.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package TomsToolbox.Settings.Documentation.Builder --version 1.1.0
                    


                    

                
NuGet\Install-Package TomsToolbox.Settings.Documentation.Builder -Version 1.1.0
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="TomsToolbox.Settings.Documentation.Builder" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="TomsToolbox.Settings.Documentation.Builder" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="TomsToolbox.Settings.Documentation.Builder" />
                    


                            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 TomsToolbox.Settings.Documentation.Builder --version 1.1.0
                    


                    

                
#r "nuget: TomsToolbox.Settings.Documentation.Builder, 1.1.0"
#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 TomsToolbox.Settings.Documentation.Builder@1.1.0
#: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=TomsToolbox.Settings.Documentation.Builder&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=TomsToolbox.Settings.Documentation.Builder&version=1.1.0
                    


                            Install as a Cake Tool

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
  • 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.

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 was computed.  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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 92 5/21/2026
1.0.0 130 1/12/2026
1.0.0-beta9 110 1/9/2026
1.0.0-beta8 111 1/9/2026
1.0.0-beta7 112 1/9/2026
1.0.0-beta6 113 1/9/2026
1.0.0-beta5 110 1/9/2026
1.0.0-beta4 115 1/9/2026
1.0.0-beta3 106 1/6/2026
1.0.0-beta2 109 1/6/2026
1.0.0-beta10 112 1/10/2026
1.0.0-beta1 117 1/5/2026