This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.MkDocs.

Summary

Check is provided MkDocs tool is in supported version.

Assembly: Cake.MkDocs.dll
Namespace: Cake.MkDocs
Containing Type: MkDocsAliases

Syntax

public static bool MkDocsIsSupportedVersion(this ICakeContext context, MkDocsVersionSettings settings)

Examples

bool isMkDocsSupported = MkDocsIsSupportedVersion(new MkDocsVersionSettings()
{
    Quiet = true
});
if (!isMkDocsSupported)
    throw new Exception("Installed unsupported MkDocs version");

bool isSupported = MkDocsIsSupportedVersion(new MkDocsVersionSettings()
{
    ToolPath = "./path-to-local-tool/bin/mkdocs"
});
Information($"Is provided MkDocs version supported: {isSupported}");

Attributes

Type	Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

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

Return Value

Type	Description
bool	`true` - version is supported; otherwise, `false`.