MkDocsAliases.

MkDocsVersion(ICakeContext, MkDocsVersionSettings) Method

Summary

Show the MkDocs version.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Containing Type
MkDocsAliases

Syntax

public static Version MkDocsVersion(this ICakeContext context, MkDocsVersionSettings settings)

Examples

var mkDocsVersion = MkDocsVersion(new MkDocsVersionSettings()
{
    Quiet = true
});
Information($"MkDocs tool version: {mkDocsVersion}"); // 1.0.4
var mkDocsVersion = MkDocsVersion(new MkDocsVersionSettings()
{
    ToolPath = "./path-to-local-tool/bin/mkdocs"
});
Information($"MkDocs tool version: {mkDocsVersion}"); // e.g. - 0.16.0

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings MkDocsVersionSettings The settings.

Return Value

Type Description
Version MkDocs tool version in Version format.