DocFx Config (docfx.json)

Contains all the files to generate documentation, including metadata yml files and conceptual md files.

Contains all the resource files that conceptual and metadata files dependent on, e.g. image files.

Contains all the conceptual files which contains yaml header with uid and is intended to override the existing metadata yml files.

[Obsoleted] Contains rpk files that define the external references.

Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, ftp, file, embedded.

Contains metadata that will be applied to every file, in key-value pair format.

Specify a list of JSON file path containing globalMetadata settings, as similar to {"key":"value"}.

Contains metadata that will be applied to specific files.

Specify a list of JSON file path containing fileMetadata settings, as similar to {"key":"value"}.

The latter ones will override the former ones if the name of the file inside the template collides. If omitted, embedded default template will be used.

The themes applied to the documentation. Theme is used to customize the styles generated by template. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If omitted, no theme will be applied, the default theme inside the template will be used.

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

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.

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

Specify the port of the hosted website.

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

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.

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

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.

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

Set the max parallelism, 0 (default) is same as the count of CPU cores.

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.

Set the name of markdown engine, default is dfm, and another built-in engine is gfm.

Set the parameters for markdown engine.

Disable default lang keyword, e.g. null.

If set to true, DocFX would not fetch Git related information for articles.

If set to true, DocFX does not copy file to the output folder. Instead, it saves a link_to_path property inside manifest.json.

If set to true, cleans up historical cache data when building.

Defines the source projects to have metadata generated.

Defines the output folder of the generated metadata files.

If set to true, DocFX would not fetch Git related information for articles.

If set to true, disables default API visibility filter rule.

If set to true, it would disable incremental build.

If set to true, DocFX would not render triple-slash-comments in source code as markdown.

Defines the filter configuration file.

If set to true, DocFX would keep ` in comment id instead of replacing it with -.

The file glob pattern collection, with path relative to property src/cwd if value is set.

The name of current item, the value is not used for now.

The file glob pattern collection for files that should be excluded, with path relative to property src/cwd if value is set.

Defines the root folder for the source files, it has the same meaning as cwd

[Obsoleted] Defines the root folder for the source files, it has the same meaning as src

The destination folder for the files if copy/transform is used.

Version name for the current file-mapping item. If not set, treat the current file-mapping item as in default version. Mappings with the same version name will be built together. Cross reference doesn't support cross different versions.

The Root TOC Path used for navbar in current version, relative to output root. If not set, will use the toc in output root in current version if exists.

Pattern match will be case sensitive. By default the pattern is case insensitive.

Disable pattern begin with ! to mean negate. By default the usage is enabled.

Disable {a,b}c => ["ac", "bc"]. By default the usage is enabled.

Disable the usage of \ to escape values. By default the usage is enabled.

Disable the usage of ** to match everything including / when it is the beginning of the pattern or is after /. By default the usage is enable.

Allow files start with . to be matched even if . is not explicitly specified in the pattern. By default files start with . will not be matched by * unless the pattern starts with ..