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
Run the builtin development server.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .Serve - Containing Type
- MkDocsServeRunner
Syntax
public void Serve(DirectoryPath projectDirectory, MkDocsServeSettings settings)Examples
runner.Serve(new DirectoryPath("./project-with-docs-is-here"), new MkDocsServeSettings());Parameters
| Name | Type | Description |
|---|---|---|
| projectDirectory | DirectoryPath | Project dir to serve. |
| settings | MkDocsServeSettings | The settings. |
Return Value
| Type | Description |
|---|---|
| void |