Class DocFxConfig

Namespace
DocFxHelper
Assembly
DocBuilder.dll

The root class in a heirarchy used to create a valid DocFx.json file for statoc site generation. The DocBuilder PowerShell module populates an instance of the object and its collections and serializes the result to JSON for consumption by DocFx.

See https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html

public class DocFxConfig
Inheritance
DocFxConfig
Inherited Members

Properties

build

Specifies what to build

public BuildConfig build { get; set; }

Property Value

BuildConfig

metadata

Configures the source, current working directory, and file types to ignore

public List<MetadataConfig> metadata { get; set; }

Property Value

List<MetadataConfig>