Novacta.Documentation.CodeExamples 2.0.0

Prefix Reserved
.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Novacta.Documentation.CodeExamples --version 2.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Novacta.Documentation.CodeExamples" />
                    


                            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 Novacta.Documentation.CodeExamples --version 2.0.0
                    


                    

                
#r "nuget: Novacta.Documentation.CodeExamples, 2.0.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 Novacta.Documentation.CodeExamples@2.0.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=Novacta.Documentation.CodeExamples&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Novacta.Documentation.CodeExamples&version=2.0.0
                    


                            Install as a Cake Tool

Novacta.Documentation.CodeExamples

Novacta.Documentation.CodeExamples is a .NET 10 library which provides support for managing synchronous or asynchronous code examples in documentation files.

Code examples can be defined in a console application, checked for successful execution, and their console outputs automatically captured and included in the documentation.

Documentation

Inspect the tutorial to get started.

Full documentation is located here.

Installation

Installation is performed via NuGet.

Parts of the sample code require the Sandcastle Help File Builder.

Versioning

We use SemVer for versioning. For available versions, see the tags on this repository.

License

Novacta.Documentation.CodeExamples is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET 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.

  • net10.0

    • No dependencies.

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
2.0.0 96 8/25/2026
1.0.0 1,812 4/30/2018

Added support for asynchronous code examples.