Table of Contents

Class ReportDataMarkdownFormatter

Namespace
Invex.Atom.Build.Reports
Assembly
Invex.Atom.Build.dll

A static class that provides functionality to format a collection of IReportData objects into a GitHub Flavored Markdown string.

public static class ReportDataMarkdownFormatter
Inheritance
object
ReportDataMarkdownFormatter

Remarks

This formatter organizes report data into a structured Markdown document, handling logs, artifacts, tables, lists, and free-form text. It uses GitHub-specific features like callouts and collapsible sections for a rich presentation.

Methods

Write(IReadOnlyList<IReportData>)

Converts a collection of report data into a formatted Markdown string.

public static string Write(IReadOnlyList<IReportData> reportData)

Parameters

reportData IReadOnlyList<IReportData>

A read-only list of IReportData objects to be formatted.

Returns

string

A string containing the complete Markdown-formatted report.