MkDocs

Summary

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"

Build

MkDocsBuild(ICakeContext) Build the MkDocs documentation in working directory.
Addin from Cake.MkDocs.dll
MkDocsBuild(ICakeContext, DirectoryPath) Build the MkDocs documentation.
Addin from Cake.MkDocs.dll
MkDocsBuild(ICakeContext, DirectoryPath, MkDocsBuildSettings) Build the MkDocs documentation.
Addin from Cake.MkDocs.dll
MkDocsBuild(ICakeContext, MkDocsBuildSettings) Build the MkDocs documentation in working directory.
Addin from Cake.MkDocs.dll

GhDeploy

MkDocsGhDeploy(ICakeContext) Deploy your documentation to GitHub Pages (project in working directory).
Addin from Cake.MkDocs.dll
MkDocsGhDeploy(ICakeContext, DirectoryPath) Deploy your documentation to GitHub Pages.
Addin from Cake.MkDocs.dll
MkDocsGhDeploy(ICakeContext, DirectoryPath, MkDocsGhDeploySettings) Deploy your documentation to GitHub Pages.
Addin from Cake.MkDocs.dll
MkDocsGhDeploy(ICakeContext, MkDocsGhDeploySettings) Deploy your documentation to GitHub Pages (project in working directory).
Addin from Cake.MkDocs.dll

New

MkDocsNew(ICakeContext) Create a new MkDocs project in working directory.
Addin from Cake.MkDocs.dll
MkDocsNew(ICakeContext, DirectoryPath) Create a new MkDocs project.
Addin from Cake.MkDocs.dll
MkDocsNew(ICakeContext, DirectoryPath, MkDocsNewSettings) Create a new MkDocs project.
Addin from Cake.MkDocs.dll
MkDocsNew(ICakeContext, MkDocsNewSettings) Create a new MkDocs project in working directory.
Addin from Cake.MkDocs.dll

Serve

MkDocsServe(ICakeContext) Run the builtin development server async in working directory.
Addin from Cake.MkDocs.dll
MkDocsServe(ICakeContext, DirectoryPath) Run the builtin development server.
Addin from Cake.MkDocs.dll
MkDocsServe(ICakeContext, DirectoryPath, MkDocsServeSettings) Run the builtin development server.
Addin from Cake.MkDocs.dll
MkDocsServe(ICakeContext, MkDocsServeSettings) Run the builtin development server async in working directory.
Addin from Cake.MkDocs.dll
MkDocsServeAsync(ICakeContext) Run the builtin development server async in working directory.
Addin from Cake.MkDocs.dll
MkDocsServeAsync(ICakeContext, DirectoryPath) Run the builtin development server async.
Addin from Cake.MkDocs.dll
MkDocsServeAsync(ICakeContext, DirectoryPath, MkDocsServeAsyncSettings) Run the builtin development server async.
Addin from Cake.MkDocs.dll
MkDocsServeAsync(ICakeContext, MkDocsServeAsyncSettings) Run the builtin development server async in working directory.
Addin from Cake.MkDocs.dll

Version

MkDocsIsSupportedVersion(ICakeContext) Check is provided MkDocs tool is in supported version.
Addin from Cake.MkDocs.dll
MkDocsIsSupportedVersion(ICakeContext, MkDocsVersionSettings) Check is provided MkDocs tool is in supported version.
Addin from Cake.MkDocs.dll
MkDocsVersion(ICakeContext) Show the MkDocs version.
Addin from Cake.MkDocs.dll
MkDocsVersion(ICakeContext, MkDocsVersionSettings) Show the MkDocs version.
Addin from Cake.MkDocs.dll