Documentation

BenchmarkDotNet uses DocFX as a documentation generation tool.

Hints

If you want to provide a link to API, you can use cross references by UID. For example, [SimpleJobAttribute](xref:BenchmarkDotNet.Attributes.SimpleJobAttribute) and @BenchmarkDotNet.Attributes.SimpleJobAttribute will be transformed to SimpleJobAttribute.

DocFX uses the following syntax inside block quote for different types of notes:

markdown

> [!NOTE]
> note content
> [!TIP]
> tip content
> [!WARNING]
> warning content
> [!IMPORTANT]
> important content
> [!Caution]
> caution content

It will be transformed to:

[!NOTE] note content

[!TIP] tip content

[!WARNING] warning content

[!IMPORTANT] important content

[!Caution] caution content

You can build documentation locally with the help of the docs-build build task:

build.cmd docs-build