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 new tool creates a new MkDocs project.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs.New

Base Types

graph BT Type-->Base0["MkDocsTool<MkDocsNewSettings>"] Base0-->Base1["Tool<MkDocsNewSettings>"] Type["MkDocsNewRunner"] class Type type-node

Syntax

public sealed class MkDocsNewRunner : MkDocsTool<MkDocsNewSettings>

Name	Summary
MkDocsNewRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)	Initializes a new instance of the `MkDocsNewRunner` class.

Name	Value	Summary
New(DirectoryPath, MkDocsNewSettings)	void	Create a new `MkDocs` project.
New(MkDocsNewSettings)	void	Create a new `MkDocs` project in current directory.

Name	Value	Summary
Dump<MkDocsNewRunner>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MkDocsNewRunner>(MkDocsNewRunner[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MkDocsNewRunner>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<MkDocsNewRunner>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<MkDocsNewRunner>(string, string)	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<MkDocsNewRunner>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin