DocFx (Fake)

6.0.0

Lookig for older versions of the documentation, pre FAKE v6? See

DocFx Module

Namespace: Fake.Documentation
Assembly: Fake.Documentation.DocFx.dll

Contains helper functions to use DocFx

Types

Type	Description
BuildParams	Build-Command parameters
CommonParams	Common parameters for DocFx executable
DownloadParams	Download-Command parameters
ExportTemplateParams	ExportTemplate-Command parameters
InitParams	Init-Command parameters
LogLevel	The available log levels
LogParams	Parameters for logging
MetadataParams	Metadata-Command parameters
PdfParams	Pdf-Command parameters
ServeParams	Serve-Command parameters

Functions and values

Function or value	Description
`DocFx.build setParams` Full Usage: `DocFx.build setParams` Parameters: setParams : `BuildParams -> BuildParams` - Function used to manipulate the default build parameters. See `BuildParams.Create()`	Builds a DocFx documentation. setParams : `BuildParams -> BuildParams` Function used to manipulate the default build parameters. See `BuildParams.Create()` Example `DocFx.build (fun p -> { p with OutputFolder = "build" @@ "docs" ConfigFile = "docs" @@ "docfx.json" })`
`DocFx.download setParams` Full Usage: `DocFx.download setParams` Parameters: setParams : `DownloadParams -> DownloadParams` - Function used to manipulate the default download parameters. See `DownloadParams.Create()`	Download xref archive. setParams : `DownloadParams -> DownloadParams` Function used to manipulate the default download parameters. See `DownloadParams.Create()` Example `DocFx.download (fun p -> { p with ArchiveFile = "archive" Uri = "uri" })`
`DocFx.exec setParams command args` Full Usage: `DocFx.exec setParams command args` Parameters: setParams : `CommonParams -> CommonParams` command : `string` - The command to execute args : `string` - The arguments list to give to the command	Execute the given DocFx command setParams : `CommonParams -> CommonParams` command : `string` The command to execute args : `string` The arguments list to give to the command Example `DocFx.exec docfx_project\docfx.json --serve`
`DocFx.exportTemplate setParams` Full Usage: `DocFx.exportTemplate setParams` Parameters: setParams : `ExportTemplateParams -> ExportTemplateParams` - Function used to manipulate the default exportTemplate parameters. See `ExportTemplateParams.Create()`	Exports template files. setParams : `ExportTemplateParams -> ExportTemplateParams` Function used to manipulate the default exportTemplate parameters. See `ExportTemplateParams.Create()` Example `DocFx.exportTemplate (fun p -> { p with All = true OutputFolder = "templates" })`
`DocFx.init setParams` Full Usage: `DocFx.init setParams` Parameters: setParams : `InitParams -> InitParams` - Function used to manipulate the default Init parameters. See `InitParams.Create()`	Initialize a DocFx documentation. setParams : `InitParams -> InitParams` Function used to manipulate the default Init parameters. See `InitParams.Create()` Example `DocFx.init (fun p -> { p with Overwrite = true Timeout = TimeSpan.FromMinutes 10. })`
`DocFx.metadata setParams` Full Usage: `DocFx.metadata setParams` Parameters: setParams : `MetadataParams -> MetadataParams` - Function used to manipulate the default serve parameters. See `MetadataParams.Create()`	Serves a DocFx documentation. setParams : `MetadataParams -> MetadataParams` Function used to manipulate the default serve parameters. See `MetadataParams.Create()` Example `DocFx.metadata (fun p -> { p with ConfigFile = "docs" @@ "docfx.json" DisableGitFeatures = true })`
`DocFx.pdf setParams` Full Usage: `DocFx.pdf setParams` Parameters: setParams : `PdfParams -> PdfParams` - Function used to manipulate the default pdf parameters. See `PdfParams.Create()`	Builds a Pdf-File from a DocFx documentation. setParams : `PdfParams -> PdfParams` Function used to manipulate the default pdf parameters. See `PdfParams.Create()` Example `DocFx.pdf (fun p -> { p with Name = "Docs.pdf" } .WithBuildParams (fun b -> { b with OutputFolder = "build" @@ "docs" ConfigFile = "docs" @@ "docfx.json"}) )`
`DocFx.serve setParams` Full Usage: `DocFx.serve setParams` Parameters: setParams : `ServeParams -> ServeParams` - Function used to manipulate the default serve parameters. See `ServeParams.Create()`	Serves a DocFx documentation. setParams : `ServeParams -> ServeParams` Function used to manipulate the default serve parameters. See `ServeParams.Create()` Example `DocFx.serve (fun p -> { p with Host = "localhost" Port = Some 80 Folder = "docs" })`