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.DocFx.

Summary

Contains functionality related to serving websites using DocFx.

Assembly

Cake.DocFx.dll

Namespace

Cake.DocFx

Base Types

graph BT Type-->Base0["Object"] Type["DocFxServeAliases"] class Type type-node

Syntax

public static class DocFxServeAliases

Type	Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Name	Value	Summary
DocFxServe(ICakeContext, DirectoryPath, DocFxServeSettings)	void	Serve a website from the specified directory with the specified settings. static
DocFxServe(ICakeContext, DirectoryPath)	void	Serve a website from the specified directory. static
DocFxServe(ICakeContext)	void	Serve a website from the current directory. static
DocFxServeStart(ICakeContext, DirectoryPath, DocFxServeSettings)	IProcess	Start serving a website from the specified directory with the specified settings. static
DocFxServeStart(ICakeContext, DirectoryPath)	IProcess	Start serving a website from the specified directory. static
DocFxServeStart(ICakeContext)	IProcess	Start serving a website from the current directory. static

Name	Value	Summary
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