MkDocsAliases.

MkDocsBuild(ICakeContext, DirectoryPath, MkDocsBuildSettings) Method

Summary

Build the MkDocs documentation.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Containing Type
MkDocsAliases

Syntax

public static void MkDocsBuild(this ICakeContext context, DirectoryPath projectDirectory, MkDocsBuildSettings settings)

Examples

MkDocsBuild("./docs-project", new MkDocsBuildSettings()
{
    Dirty = true,
    Theme = MkDocsTheme.ReadTheDocs
});
MkDocsBuild(new DirectoryPath("./docs-project"), new MkDocsBuildSettings()
{
    Dirty = true,
    Theme = MkDocsTheme.ReadTheDocs
});

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext The context.
projectDirectory DirectoryPath Project directory path to build.
settings MkDocsBuildSettings The settings.

Return Value

Type Description
void