Cake.MkDocs.dll Assembly

Class Types

Class Summary
MkDocsAddress Represents IP address and port used in settings.
MkDocsAliases Contains functionalities for working with MkDocs.

Contains functionality related to MkDocs.

In order to use the commands for this alias, include the following in your build.cake file to download and install from NuGet.org, or specify the ToolPath within the correct ToolSettings class: 

#addin "Cake.MkDocs"
#addin "nuget:?package=Cake.MkDocs"
MkDocsArgumentAttribute Describes tool argument related to settings MkDocsSettings.
MkDocsArgumentValueAttribute Describes tool argument named values related to settings MkDocsSettings.
MkDocsBuildRunner The MkDocs build tool for MkDocs project.
MkDocsBuildSettings Contains settings used by MkDocsBuildRunner.
MkDocsGhDeployRunner The MkDocs gh-deploy tool deploying created site to GitHub Pages.
MkDocsGhDeploySettings Contains settings used by MkDocsGhDeployRunner.
MkDocsNewRunner The MkDocs new tool creates a new MkDocs project.
MkDocsNewSettings Contains settings used by MkDocsNewRunner.
MkDocsServeAsyncRunner The MkDocs serve async tool buid and generate preview of MkDocs documentation.
MkDocsServeAsyncSettings Contains settings used by MkDocsServeAsyncRunner.
MkDocsServeRunner The MkDocs serve tool buid and generate preview of MkDocs documentation.
MkDocsServeSettings Contains settings used by MkDocsServeRunner.
MkDocsSettings Base MkDocs settings class.
MkDocsTheme Represents MkDocs themes.
MkDocsTool<TSettings> Base class for all MkDocs related tools.
MkDocsVersionRunner The MkDocs version tool provides information about tool and addin versions compatibility.
MkDocsVersionSettings Contains settings used by MkDocsVersionRunner.