DocFxOptions Class

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides options for generating documentation addresses compatible with DocFx.
public class DocFxOptions : HtmlAddressingOptions
Inheritance

Remarks

The DocFxOptions class provides configuration for documentation file addressing specifically tailored for DocFx documentation generator compatibility.

This class implements the following default configuration:
  • Sets file extension to HTML (.html)
  • Includes file extensions in generated URLs
  • Uses the api path for API documentation
  • Places top-level topic files in the root directory
These settings align with DocFx's conventional file organization and URL structure.

Constructors

DocFxOptions()Initializes a new instance of the DocFxOptions class.

See Also