MarkdownReporter

MarkdownReporter writes results to a .md file as a formatted table. It is part of the core NBenchmark package with no additional dependencies.

Markdown output is a good choice for committing results to source control, attaching to pull requests, or including in documentation.

Setup

using NBenchmark.Reporters;

// Default path - auto-generates a timestamped filename
.WithReporter(new MarkdownReporter())

// Explicit path
.WithReporter(new MarkdownReporter("results/benchmark.md"))

Default filename

When constructed with no arguments (or the literal default path), MarkdownReporter generates a timestamped filename to avoid overwriting previous runs:

benchmark-results-20260606-034000.md

Pass an explicit path if you always want the same filename.

Output format

## Benchmark Results

_Run at 2026-06-06 03:40:00 UTC - 25 warmup / 190 measured_

| Benchmark | Median | Mean | Error | StdDev | P95 | P99 | Ratio | Sig | Alloc/op |
|---|---:|---:|---:|---:|---:|---:|---:|---:|---:|
| Compute | 300.0 ns | 275.3 ns | ±16.2 ns | 85.9 ns | 500.0 ns | 500.0 ns | 0.75x | ✓ | - |
| Baseline | 400.0 ns | 375.8 ns | ±21.6 ns | 114.3 ns | 500.0 ns | 900.0 ns | 1.00x | - | - |

_Error = ±95% confidence interval half-width on the mean._

Columns

Column	Description
Benchmark	Benchmark name.
Median	Median timing.
Mean	Arithmetic mean.
Error	±Margin of error on the mean.
StdDev	Sample standard deviation.
P95	95th percentile.
P99	99th percentile.
Ratio	Speed relative to the baseline.
Sig	✓ = significant, ~ = not significant, - = not applicable.
Alloc/op	Mean bytes allocated per iteration, or - if not measured.

Notes

• Results are sorted by median (fastest first).
• Errored benchmarks are listed with a - in the Error, Ratio, and Sig columns. The Median, Mean, StdDev, P95, and P99 columns show 0.0 ns.
• The output directory must already exist. MarkdownReporter does not create it.

Using with Benchmark (Quick mode)

var result = Benchmark.Run(() => MyMethod());
await result.ToMarkdownAsync("results.md");

CLI usage (BenchmarkHost)

dotnet run -- --reporter markdown
dotnet run -- --reporter markdown --output ./results

When --output is specified, the file is written as benchmark-results.md inside that directory.