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
Checks if provided
MkDocs
tool version is compatible with addin.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .Version - Containing Type
- MkDocsVersionRunner
Syntax
public bool IsSupportedVersion(MkDocsSettings settings)
Examples
bool isSupported = runner.IsSupportedVersion(new MkDocsNewSettings() { ToolPath = "./path-to-local-tool/bin/mkdocs" });
Parameters
Name | Type | Description |
---|---|---|
settings | MkDocsSettings | The settings. |
Return Value
Type | Description |
---|---|
bool | true - MkDocs version is compatible with addin; otherwise, false . |