MkDocs aliases

Cake.MkDocs addin

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()
Alias from Cake.MkDocs addin
Build the MkDocs documentation in working directory.
MkDocsBuild(DirectoryPath)
Alias from Cake.MkDocs addin
Build the MkDocs documentation.
MkDocsBuild(DirectoryPath, MkDocsBuildSettings)
Alias from Cake.MkDocs addin
Build the MkDocs documentation.
MkDocsBuild(MkDocsBuildSettings)
Alias from Cake.MkDocs addin
Build the MkDocs documentation in working directory.

GhDeploy

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

New

MkDocsNew()
Alias from Cake.MkDocs addin
Create a new MkDocs project in working directory.
MkDocsNew(DirectoryPath)
Alias from Cake.MkDocs addin
Create a new MkDocs project.
MkDocsNew(DirectoryPath, MkDocsNewSettings)
Alias from Cake.MkDocs addin
Create a new MkDocs project.
MkDocsNew(MkDocsNewSettings)
Alias from Cake.MkDocs addin
Create a new MkDocs project in working directory.

Serve

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

Version

MkDocsIsSupportedVersion()
Alias from Cake.MkDocs addin
Check is provided MkDocs tool is in supported version.
MkDocsIsSupportedVersion(MkDocsVersionSettings)
Alias from Cake.MkDocs addin
Check is provided MkDocs tool is in supported version.
MkDocsVersion()
Alias from Cake.MkDocs addin
Show the MkDocs version.
MkDocsVersion(MkDocsVersionSettings)
Alias from Cake.MkDocs addin
Show the MkDocs version.