MkDocsAliases Class

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"

Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["MkDocsAliases"] class Type type-node

Syntax

public static class MkDocsAliases

Remarks

See NuGet.org.

See MkDocs repository.

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
MkDocsBuild(ICakeContext) void
Build the MkDocs documentation in working directory.
static
MkDocsBuild(ICakeContext, DirectoryPath) void
Build the MkDocs documentation.
static
MkDocsBuild(ICakeContext, DirectoryPath, MkDocsBuildSettings) void
Build the MkDocs documentation.
static
MkDocsBuild(ICakeContext, MkDocsBuildSettings) void
Build the MkDocs documentation in working directory.
static
MkDocsGhDeploy(ICakeContext) void
Deploy your documentation to GitHub Pages (project in working directory).
static
MkDocsGhDeploy(ICakeContext, DirectoryPath) void
Deploy your documentation to GitHub Pages.
static
MkDocsGhDeploy(ICakeContext, DirectoryPath, MkDocsGhDeploySettings) void
Deploy your documentation to GitHub Pages.
static
MkDocsGhDeploy(ICakeContext, MkDocsGhDeploySettings) void
Deploy your documentation to GitHub Pages (project in working directory).
static
MkDocsIsSupportedVersion(ICakeContext) bool
Check is provided MkDocs tool is in supported version.
static
MkDocsIsSupportedVersion(ICakeContext, MkDocsVersionSettings) bool
Check is provided MkDocs tool is in supported version.
static
MkDocsNew(ICakeContext) void
Create a new MkDocs project in working directory.
static
MkDocsNew(ICakeContext, DirectoryPath) void
Create a new MkDocs project.
static
MkDocsNew(ICakeContext, DirectoryPath, MkDocsNewSettings) void
Create a new MkDocs project.
static
MkDocsNew(ICakeContext, MkDocsNewSettings) void
Create a new MkDocs project in working directory.
static
MkDocsServe(ICakeContext) void
Run the builtin development server async in working directory.
static
MkDocsServe(ICakeContext, DirectoryPath) void
Run the builtin development server.
static
MkDocsServe(ICakeContext, DirectoryPath, MkDocsServeSettings) void
Run the builtin development server.
static
MkDocsServe(ICakeContext, MkDocsServeSettings) void
Run the builtin development server async in working directory.
static
MkDocsServeAsync(ICakeContext) Task
Run the builtin development server async in working directory.
static
MkDocsServeAsync(ICakeContext, DirectoryPath) Task
Run the builtin development server async.
static
MkDocsServeAsync(ICakeContext, DirectoryPath, MkDocsServeAsyncSettings) Task
Run the builtin development server async.
static
MkDocsServeAsync(ICakeContext, MkDocsServeAsyncSettings) Task
Run the builtin development server async in working directory.
static
MkDocsVersion(ICakeContext) Version
Show the MkDocs version.
static
MkDocsVersion(ICakeContext, MkDocsVersionSettings) Version
Show the MkDocs version.
static