DocFxPdfAliases Class

Summary

Contains functionality related to creating PDF files using DocFx.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DocFxPdfAliases"] class Type type-node

Syntax

public static class DocFxPdfAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
DocFxPdf(ICakeContext, DocFxPdfSettings) void
Generates a PDF document for the docfx.json file in the current working directory using the specified settings.
static
DocFxPdf(ICakeContext, FilePath, DocFxPdfSettings) void
Generates a PDF document for a specific docfx.json file using the specified settings.
static
DocFxPdf(ICakeContext, FilePath) void
Generates a PDF document for a specific docfx.json file.
static
DocFxPdf(ICakeContext) void
Generates a PDF document for the docfx.json file in the current working directory.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin