DocFx.BuildParams Type
Build-Command parameters
Record fields
Record Field | Description |
Full Usage:
ChangesFile
Field type: string
|
|
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.
|
|
|
Full Usage:
ConfigFile
Field type: string
|
|
Full Usage:
Content
Field type: string list
|
|
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.
|
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.
|
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.
|
Full Usage:
ExportRawModel
Field type: bool
|
|
Full Usage:
ExportViewModel
Field type: bool
|
|
Full Usage:
FALName
Field type: string
|
|
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.
|
Full Usage:
ForcePostProcess
Field type: bool
|
|
Full Usage:
ForceRebuild
Field type: bool
|
|
Full Usage:
GlobalMetadata
Field type: string
|
Specify global metadata key-value pair in json format. It overrides the globalMetadata settings from the config file.
|
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.
|
Full Usage:
Host
Field type: string
|
|
Full Usage:
IntermediateFolder
Field type: string
|
|
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.
|
|
|
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.
|
Full Usage:
MarkdownEngineName
Field type: string
|
|
Full Usage:
MarkdownEngineProperties
Field type: string
|
|
Full Usage:
MaxParallelism
Field type: int option
|
|
Full Usage:
NoLangKeyword
Field type: bool option
|
|
Full Usage:
OutputFolder
Field type: string
|
|
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.
|
Full Usage:
Overwrite
Field type: string list
|
|
Full Usage:
Port
Field type: int option
|
|
Full Usage:
PostProcessors
Field type: string list
|
|
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.
|
Full Usage:
Resource
Field type: string list
|
|
Full Usage:
SchemaLicense
Field type: string
|
|
Full Usage:
Serve
Field type: bool
|
|
Full Usage:
Templates
Field type: string list
|
|
Full Usage:
Themes
Field type: string list
|
|
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.
|
Full Usage:
XRefMaps
Field type: string list
|
|
Instance members
Instance member | Description |
Full Usage:
this.WithCommon
Parameters:
CommonParams -> CommonParams
Returns: BuildParams
Modifiers: inline |
|
|
|
Static members
Static member | Description |
|
|