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 building websites using DocFx.

Assembly

Cake.DocFx.dll

Namespace

Cake.DocFx

Base Types

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

Syntax

public static class DocFxBuildAliases

Type	Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Name	Value	Summary
DocFxBuild(ICakeContext, DocFxBuildSettings)	void	Generate client-only website combining API in YAML files and conceptual files for the `docfx.json` file in the current working directory using the specified settings. static
DocFxBuild(ICakeContext, FilePath, DocFxBuildSettings)	void	Generate client-only website combining API in YAML files and conceptual files for a specific `docfx.json` file using the specified settings. static
DocFxBuild(ICakeContext, FilePath)	void	Generate client-only website combining API in YAML files and conceptual files for a specific `docfx.json` file. static
DocFxBuild(ICakeContext)	void	Generate client-only website combining API in YAML files and conceptual files for the `docfx.json` file in the current working 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