MkDocsAliases.

MkDocsNew(ICakeContext, DirectoryPath, MkDocsNewSettings) Method

Summary

Create a new MkDocs project.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Containing Type
MkDocsAliases

Syntax

public static void MkDocsNew(this ICakeContext context, DirectoryPath projectDirectory, MkDocsNewSettings settings)

Examples

MkDocsNew("./docs-project", new MkDocsNewSettings()
{
    Verbose = true
});
MkDocsNew(new DirectoryPath("./docs-project") ,new MkDocsNewSettings()
{
    Verbose = true
});

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext The context.
projectDirectory DirectoryPath New project directory path.
settings MkDocsNewSettings The settings.

Return Value

Type Description
void