Cake.DocFx

Cake AddIn that generates documentation for .Net API reference and markdown files using DocFx.

#addin nuget:?package=Cake.DocFx&version=0.13.1

<package id="Cake.DocFx" version="0.13.1" />

dotnet add package Cake.DocFx --version 0.13.1

<PackageReference Include="Cake.DocFx" Version="0.13.1" />

Aliases

Contains functionality related to creating new DocFx projects.

Build

DocFx(ICakeContext) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext) instead.
DocFx(ICakeContext, DocFxSettings) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.DocFx.Build.DocFxBuildSettings) instead.
DocFx(ICakeContext, FilePath) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath) instead.
DocFx(ICakeContext, FilePath, DocFxSettings) Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.DocFx.Build.DocFxBuildSettings) instead.
DocFxBuild(ICakeContext) Generate client-only website combining API in YAML files and conceptual files for the docfx.json file in the current working directory.
DocFxBuild(ICakeContext, DocFxBuildSettings) 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.
DocFxBuild(ICakeContext, FilePath) Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file.
DocFxBuild(ICakeContext, FilePath, DocFxBuildSettings) Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file using the specified settings.

Init

DocFxInit(ICakeContext) Generate an initial docfx.json file.
DocFxInit(ICakeContext, DocFxInitSettings) Generate an initial docfx.json file, with the specified settings.

Merge

DocFxMerge(ICakeContext) Merge base API in YAML files and toc files for the docfx.json file in the current working directory.
DocFxMerge(ICakeContext, DocFxMergeSettings) Merge base API in YAML files and toc files for the docfx.json file in the current working directory using the specified settings.
DocFxMerge(ICakeContext, FilePath) Merge base API in YAML files and toc files for a specific docfx.json file.
DocFxMerge(ICakeContext, FilePath, DocFxMergeSettings) Merge base API in YAML files and toc files for a specific docfx.json file using the specified settings.

Metadata

DocFxMetadata(ICakeContext) Extract API documentation using DocFx for the docfx.json file in the current working directory.
DocFxMetadata(ICakeContext, DocFxMetadataSettings) Extract API documentation using DocFx, with the specified settings.
DocFxMetadata(ICakeContext, FilePath) Extract API documentation using DocFx for a specific docfx.json file.
DocFxMetadata(ICakeContext, IEnumerable<FilePath>) Extract API documentation using DocFx, with the specified project/source files or search patterns.

Pdf

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

Serve

DocFxServe(ICakeContext) Serve a website from the current directory.
DocFxServe(ICakeContext, DirectoryPath) Serve a website from the specified directory.
DocFxServe(ICakeContext, DirectoryPath, DocFxServeSettings) Serve a website from the specified directory with the specified settings.
DocFxServeStart(ICakeContext) Start serving a website from the current directory.
DocFxServeStart(ICakeContext, DirectoryPath) Start serving a website from the specified directory.
DocFxServeStart(ICakeContext, DirectoryPath, DocFxServeSettings) Start serving a website from the specified directory with the specified settings.