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
Contains settings used by
MkDocsServeRunner.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .Serve - Base Types
-
- ToolSettings
- MkDocsSettings
- Derived Types
graph BT
Type-->Base0["MkDocsSettings"]
click Base0 "/api/Cake.MkDocs/MkDocsSettings"
Base0-->Base1["ToolSettings"]
Type["MkDocsServeSettings"]
class Type type-node
Derived0["MkDocsServeAsyncSettings"]-->Type
click Derived0 "/api/Cake.MkDocs.Serve/MkDocsServeAsyncSettings"
Syntax
public class MkDocsServeSettings : MkDocsSettingsAttributes
| Type | Description |
|---|---|
| Mk |
Constructors
| Name | Summary |
|---|---|
| MkDocsServeSettings |
Properties
| Name | Value | Summary |
|---|---|---|
| ConfigFile | FilePath |
Gets or sets a value indicating whether a specific config is provided.
Provide a specific MkDocs config. |
| DevAddr | MkDocsAddress |
Gets or sets a value indicating whether custom dev address is provided.
IP address and port to serve documentation locally (default localhost:8000). |
| DirtyReload | bool |
Gets or sets a value indicating whether live reloading is enabled.
Enable the live reloading in the development server, but only re-build files that have changed. |
| LiveReload | bool |
Gets or sets a value indicating whether live reloading is enabled.
Enable the live reloading in the development server (this is the default). |
| NoLiveReload | bool |
Gets or sets a value indicating whether live reloading is disabled.
Disable the live reloading in the development server. |
| Quiet | bool |
Gets or sets a value indicating whether quiet mode is enabled.
Silence warnings. Inherited from MkDocsSettings
|
| Strict | bool |
Gets or sets a value indicating whether strict mode is enabled.
Enable strict mode. This will cause MkDocs to abort the build on any warnings. |
| Theme | Nullable |
Gets or sets a value indicating whether different theme should be used.
The theme to use when building your documentation. |
| ThemeDir | DirectoryPath |
Gets or sets a value indicating whether custom theme dir is provided.
The theme directory to use when building your documentation. |
| Verbose | bool |
Gets or sets a value indicating whether verbose mode is enabled.
Enable verbose output. Inherited from MkDocsSettings
|
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 |
Throws an exception if the specified parameter's value is null.
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 |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|