DocFxServeAliases Class

Summary

Contains functionality related to serving websites using DocFx.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DocFxServeAliases"] class Type type-node

Syntax

public static class DocFxServeAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
DocFxServe(ICakeContext) void
Serve a website from the current directory.
static
DocFxServe(ICakeContext, DirectoryPath) void
Serve a website from the specified directory.
static
DocFxServe(ICakeContext, DirectoryPath, DocFxServeSettings) void
Serve a website from the specified directory with the specified settings.
static
DocFxServeStart(ICakeContext) IProcess
Start serving a website from the current directory.
static
DocFxServeStart(ICakeContext, DirectoryPath) IProcess
Start serving a website from the specified directory.
static
DocFxServeStart(ICakeContext, DirectoryPath, DocFxServeSettings) IProcess
Start serving a website from the specified directory with the specified settings.
static

Extension Methods

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