BuildParams

Build-Command parameters

Record Fields

Record FieldDescription
ChangesFile
Signature: string

Set changes file.

CleanupCacheHistory
Signature: bool

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

Common
Signature: CommonParams

Specify common docFx options

ConfigFile
Signature: string

Specify the config file path.

Content
Signature: string list

Specify content files for generating documentation.

DisableGitFeatures
Signature: 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.

DryRun
Signature: 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.

EnableDebugMode
Signature: 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.

ExportRawModel
Signature: bool

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

ExportViewModel
Signature: bool

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

FALName
Signature: string

Set the name of input file abstract layer builder.

FileMetadataFilePaths
Signature: 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.

ForcePostProcess
Signature: bool

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

ForceRebuild
Signature: bool

Force re-build all the documentation.

GlobalMetadata
Signature: string

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

GlobalMetadataFilePaths
Signature: 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.

Host
Signature: string

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

IntermediateFolder
Signature: string

Set folder for intermediate build results.

KeepFileLink
Signature: bool

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

LogParams
Signature: LogParams

Specify Logging parameter

LruSize
Signature: 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.

MarkdownEngineName
Signature: string

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

MarkdownEngineProperties
Signature: string

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

MaxParallelism
Signature: int option

Set the max parallelism, 0 is auto.

NoLangKeyword
Signature: bool option

Disable default lang keyword.

OutputFolder
Signature: string

Specify the output base directory.

OutputFolderForDebugFiles
Signature: string

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

Overwrite
Signature: string list

Specify overwrite files used by content files.

Port
Signature: int option

Specify the port of the hosted website.

PostProcessors
Signature: string list

Set the order of post processors in plugins.

RawModelOutputFolder
Signature: 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.

Resource
Signature: string list

Specify resources used by content files.

SchemaLicense
Signature: string

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

Serve
Signature: bool

Host the generated documentation to a website.

Templates
Signature: string list

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

Themes
Signature: string list

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

ViewModelOutputFolder
Signature: 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.

XRefMaps
Signature: string list

Specify the urls of xrefmap used by content files.

Instance members

Instance memberDescription
x.WithCommon(f)
Signature: (f:(CommonParams -> CommonParams)) -> BuildParams

Changes the "Common" parameters according to the given function

x.WithLogParams(f)
Signature: (f:(LogParams -> LogParams)) -> BuildParams

Changes the "LogParams" according to the given function

Static members

Static memberDescription
BuildParams.Create()
Signature: unit -> BuildParams

Build default parameters