FAKE - F# Make - A DSL for build tasks and more FAKE
6.1.3

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

v5.fake.build

DocFx.BuildParams Type

Build-Command parameters

Record fields

Record Field Description

ChangesFile

Full Usage: ChangesFile

Field type: string

Set changes file.

Field type: string

CleanupCacheHistory

Full Usage: CleanupCacheHistory

Field type: bool

If set to true, docfx create a new intermediate folder for cache files, historical cache data will be cleaned up.

Field type: bool

Common

Full Usage: Common

Field type: CommonParams

Specify common docFx options

Field type: CommonParams

ConfigFile

Full Usage: ConfigFile

Field type: string

Specify the config file path.

Field type: string

Content

Full Usage: Content

Field type: string list

Specify content files for generating documentation.

Field type: string list

DisableGitFeatures

Full Usage: DisableGitFeatures

Field type: bool

Disable fetching Git related information for articles. By default it is enabled and may have side effect on performance when the repo is large.

Field type: bool

DryRun

Full Usage: DryRun

Field type: bool

If set to true, template will not be actually applied to the documents. This option is always used with --exportRawModel or --exportViewModel is set so that only raw model files or view model files are generated.

Field type: bool

EnableDebugMode

Full Usage: EnableDebugMode

Field type: bool

Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false.

Field type: bool

ExportRawModel

Full Usage: ExportRawModel

Field type: bool

If set to true, data model to run template script will be extracted in .raw.model.json extension.

Field type: bool

ExportViewModel

Full Usage: ExportViewModel

Field type: bool

If set to true, data model to apply template will be extracted in .view.model.json extension.

Field type: bool

FALName

Full Usage: FALName

Field type: string

Set the name of input file abstract layer builder.

Field type: string

FileMetadataFilePaths

Full Usage: FileMetadataFilePaths

Field type: string list

Specify a list of JSON file path containing fileMetadata settings, as similar to {\"key\":\"value\"}. It overrides the fileMetadata settings from the config file.

Field type: string list

ForcePostProcess

Full Usage: ForcePostProcess

Field type: bool

Force to re-process the documentation in post processors. It will be cascaded from force option.

Field type: bool

ForceRebuild

Full Usage: ForceRebuild

Field type: bool

Force re-build all the documentation.

Field type: bool

GlobalMetadata

Full Usage: GlobalMetadata

Field type: string

Specify global metadata key-value pair in json format. It overrides the globalMetadata settings from the config file.

Field type: string

GlobalMetadataFilePaths

Full Usage: GlobalMetadataFilePaths

Field type: string list

Specify a list of JSON file path containing globalMetadata settings, as similar to {\"key\":\"value\"}. It overrides the globalMetadata settings from the config file.

Field type: string list

Host

Full Usage: Host

Field type: string

Specify the hostname of the hosted website (e.g., 'localhost' or '*').

Field type: string

IntermediateFolder

Full Usage: IntermediateFolder

Field type: string

Set folder for intermediate build results.

Field type: string

KeepFileLink

Full Usage: KeepFileLink

Field type: bool

If set to true, docfx does not dereference (aka. copy) file to the output folder, instead, it saves a link_to_path property inside mainfiest.json to indicate the physical location of that file.

Field type: bool

LogParams

Full Usage: LogParams

Field type: LogParams

Specify Logging parameter

Field type: LogParams

LruSize

Full Usage: LruSize

Field type: int option

Set the LRU cached model count (approximately the same as the count of input files). By default, it is 8192 for 64bit and 3072 for 32bit process. With LRU cache enabled, memory usage decreases and time consumed increases. If set to 0, Lru cache is disabled.

Field type: int option

MarkdownEngineName

Full Usage: MarkdownEngineName

Field type: string

Set the name of markdown engine, default is 'dfm'.

Field type: string

MarkdownEngineProperties

Full Usage: MarkdownEngineProperties

Field type: string

Set the parameters for markdown engine, value should be a JSON string.

Field type: string

MaxParallelism

Full Usage: MaxParallelism

Field type: int option

Set the max parallelism, 0 is auto.

Field type: int option

NoLangKeyword

Full Usage: NoLangKeyword

Field type: bool option

Disable default lang keyword.

Field type: bool option

OutputFolder

Full Usage: OutputFolder

Field type: string

Specify the output base directory.

Field type: string

OutputFolderForDebugFiles

Full Usage: OutputFolderForDebugFiles

Field type: string

The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx.

Field type: string

Overwrite

Full Usage: Overwrite

Field type: string list

Specify overwrite files used by content files.

Field type: string list

Port

Full Usage: Port

Field type: int option

Specify the port of the hosted website.

Field type: int option

PostProcessors

Full Usage: PostProcessors

Field type: string list

Set the order of post processors in plugins.

Field type: string list

RawModelOutputFolder

Full Usage: RawModelOutputFolder

Field type: string

Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation.

Field type: string

Resource

Full Usage: Resource

Field type: string list

Specify resources used by content files.

Field type: string list

SchemaLicense

Full Usage: SchemaLicense

Field type: string

Please provide the license key for validating schema using NewtonsoftJson.Schema here.

Field type: string

Serve

Full Usage: Serve

Field type: bool

Host the generated documentation to a website.

Field type: bool

Templates

Full Usage: Templates

Field type: string list

Specify the template name to apply to. If not specified, output YAML file will not be transformed.

Field type: string list

Themes

Full Usage: Themes

Field type: string list

Specify which theme to use. By default 'default' theme is offered.

Field type: string list

ViewModelOutputFolder

Full Usage: ViewModelOutputFolder

Field type: string

Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation.

Field type: string

XRefMaps

Full Usage: XRefMaps

Field type: string list

Specify the urls of xrefmap used by content files.

Field type: string list

Instance members

Instance member Description

this.WithCommon

Full Usage: this.WithCommon

Parameters:
Returns: BuildParams
Modifiers: inline

Changes the "Common" parameters according to the given function

f : CommonParams -> CommonParams
Returns: BuildParams

this.WithLogParams

Full Usage: this.WithLogParams

Parameters:
Returns: BuildParams
Modifiers: inline

Changes the "LogParams" according to the given function

f : LogParams -> LogParams
Returns: BuildParams

Static members

Static member Description

BuildParams.Create()

Full Usage: BuildParams.Create()

Returns: BuildParams

Build default parameters

Returns: BuildParams