Expressium.LivingDoc 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Expressium.LivingDoc --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Expressium.LivingDoc" />
                    


                            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 Expressium.LivingDoc --version 1.0.0
                    


                    

                
#r "nuget: Expressium.LivingDoc, 1.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 Expressium.LivingDoc@1.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=Expressium.LivingDoc&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Expressium.LivingDoc&version=1.0.0
                    


                            Install as a Cake Tool

Expressium LivingDoc

Expressium LivingDoc is an open-source tool that generates a single HTML test report in a Living Documentation style for ReqnRoll projects.

The report is built upon the Cucumber Messages format produced by ReqnRoll during the execution of Behavior-Driven Development (BDD) tests.

The final HTML test report may along with linked attachments be distributed to a public location enabling easy access by the stackholders.

<br /> <img src="ExpressiumLivingDoc.png" alt="Expressium LivingDoc" style="display: block; margin-left: auto; margin-right: auto; width: 80%;" />

How-To-Use

  • Add the Expressium.LivingDoc.ReqnrollPlugin NuGet package to the ReqnRoll test project...
  • Setup the Expressium formatters properties in the configuration of ReqnRoll test project...
  • Run the tests in the ReqnRoll test project and open the HTML report in the output directory...

ReqnRoll Configuration

{
  "$schema": "https://schemas.reqnroll.net/reqnroll-config-latest.json",
  "formatters": {
    "expressium": {
      "outputFilePath": "LivingDoc.ndjson",
      "outputFileTitle": "Expressium.Coffeeshop.Web.API.Tests"
    }
  }
}

Attachments Work-Around

Since the AddAttachment API in ReqnRoll doesn�t support adding attachments as links, we need to use a workaround to enable attachments in the Expressium LivingDoc report.

using Reqnroll;

namespace MyCompany.MyProject.Web.API.Tests
{
    internal static class ReqnRollExtensions
    {
        internal static void AddAttachmentAsLink(this IReqnrollOutputHelper outputHelper, string path)
        {
            outputHelper.WriteLine($"[Attachment: {path}]");
        }
    }
}

Expressium LivingDoc Demo Test Report

Web: https://expressium.dev/reqnroll/LivingDoc.html

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 was computed.  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 (1)

Showing the top 1 NuGet packages that depend on Expressium.LivingDoc:

Package Downloads
Expressium.LivingDoc.ReqnrollPlugin

LivingDoc Test Report PlugIn for ReqnRoll Projects

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 34 9/10/2025