This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see
Cake.MkDocs.
Summary
Build the MkDocs documentation.
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
