Cake.MkDocs

Cake Addin that extends Cake with ability to run the MkDocs.

#addin nuget:?package=Cake.MkDocs&version=2.1.1

<package id="Cake.MkDocs" version="2.1.1" />

dotnet add package Cake.MkDocs --version 2.1.1

<PackageReference Include="Cake.MkDocs" Version="2.1.1" />

Aliases

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

GhDeploy

MkDocsGhDeploy(ICakeContext) Deploy your documentation to GitHub Pages (project in working directory).
MkDocsGhDeploy(ICakeContext, DirectoryPath) Deploy your documentation to GitHub Pages.
MkDocsGhDeploy(ICakeContext, DirectoryPath, MkDocsGhDeploySettings) Deploy your documentation to GitHub Pages.
MkDocsGhDeploy(ICakeContext, MkDocsGhDeploySettings) Deploy your documentation to GitHub Pages (project in working directory).

New

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

Serve

MkDocsServe(ICakeContext) Run the builtin development server async in working directory.
MkDocsServe(ICakeContext, DirectoryPath) Run the builtin development server.
MkDocsServe(ICakeContext, DirectoryPath, MkDocsServeSettings) Run the builtin development server.
MkDocsServe(ICakeContext, MkDocsServeSettings) Run the builtin development server async in working directory.
MkDocsServeAsync(ICakeContext) Run the builtin development server async in working directory.
MkDocsServeAsync(ICakeContext, DirectoryPath) Run the builtin development server async.
MkDocsServeAsync(ICakeContext, DirectoryPath, MkDocsServeAsyncSettings) Run the builtin development server async.
MkDocsServeAsync(ICakeContext, MkDocsServeAsyncSettings) Run the builtin development server async in working directory.

Version

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