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
The
MkDocs serve async tool buid and generate preview of MkDocs documentation.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .Serve - Base Types
graph BT
Type-->Base0["MkDocsTool<MkDocsServeAsyncSettings>"]
Base0-->Base1["Tool<MkDocsServeAsyncSettings>"]
Type["MkDocsServeAsyncRunner"]
class Type type-node
Syntax
public sealed class MkDocsServeAsyncRunner : MkDocsTool<MkDocsServeAsyncSettings>Constructors
| Name | Summary |
|---|---|
| Mk |
Initializes a new instance of the MkDocsServeAsyncRunner class.
|
Methods
| Name | Value | Summary |
|---|---|---|
| ServeAsync |
Task |
Run the builtin development server async.
|
| ServeAsync |
Task |
Run the builtin development server in working directory async.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|