Cake.MkDocs Namespace

Summary

This namespace contain types used for common operations and Cake aliases associated with MkDocs.

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"
MkDocsSettings Base MkDocs settings class.
MkDocsTheme Represents MkDocs themes.
MkDocsTool<TSettings> Base class for all MkDocs related tools.

Namespaces

Namespace Summary
Cake.MkDocs.Attributes
Cake.MkDocs.Build This namespace contain types used for MkDocs build operations such as operation settings and project building.
Cake.MkDocs.GhDeploy This namespace contain types used for MkDocs to GitHub deploy operations such as operation settings and deployin to GitHub Pages.
Cake.MkDocs.New This namespace contain types used for MkDocs new operations such as operation settings and creating new project.
Cake.MkDocs.Serve This namespace contain types used for MkDocs serve operations such as operation settings and documentation previewing.
Cake.MkDocs.Version This namespace contain types used for MkDocs version operations such as operation settings, version displaying or supported version checking.