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 async.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .Serve - Containing Type
- Mk
Docs Serve Async Runner
Syntax
public Task ServeAsync(DirectoryPath projectDirectory, MkDocsServeAsyncSettings settings)Examples
var tokenSource = new CancellationTokenSource();
var task = runner.Serve(new DirectoryPath("./project-with-docs-is-here"),
new MkDocsServeSettings() { Token = tokenSource.Token });
// Do something...
tokenSource.Cancel();
try
{
task.Wait();
}
catch (OperationCanceledException)
{
// Handle excecption
}Parameters
| Name | Type | Description |
|---|---|---|
| projectDirectory | DirectoryPath | Project dir to serve. |
| settings | Mk |
The settings. |
Return Value
| Type | Description |
|---|---|
| Task | Long running task. |