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 creating new DocFx projects.

Assembly

Cake.DocFx.dll

Namespace

Cake.DocFx

Base Types

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

Syntax

public static class DocFxInitAliases

Type	Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Name	Value	Summary
DocFxInit(ICakeContext, DocFxInitSettings)	void	Generate an initial `docfx.json` file, with the specified settings. static
DocFxInit(ICakeContext)	void	Generate an initial `docfx.json` file. 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