Skip to content

Novacta/documentation-code-examples

Repository files navigation

Novacta.Documentation.CodeExamples

Novacta.Documentation.CodeExamples is a .NET library which provides support for managing 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.

It targets all platforms implementing the .NET Standard, version 2.0.

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.

About

A .NET library that provides support for managing code examples in documentation files.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages