A JSON schema for DocFx configuration files Json Format

metadata Metadata section defines an array of source projects and their output folder.

#	dest	disableGitFeatures	disableDefaultFilter	force	shouldSkipMarkup	raw	filter	useCompatibilityFileName	Actions
{{$index+1}}.	{{row.dest}}	{{row.disableGitFeaturesSelected.DisplayText}}	{{row.disableDefaultFilterSelected.DisplayText}}	{{row.forceSelected.DisplayText}}	{{row.shouldSkipMarkupSelected.DisplayText}}	{{row.rawSelected.DisplayText}}	{{row.filter}}	{{row.useCompatibilityFileNameSelected.DisplayText}}

.build

_

build.dest

.build.globalMetadata

_

.build.fileMetadata

_

build.serve

build.force

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

build.debug - 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.

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

build.port - Specify the port of the hosted website.

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

build.rawModelOutputFolder - 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.

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

build.viewModelOutputFolder - 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.

build.dryRun - 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.

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

build.lruSize - 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.

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

.build.markdownEngineProperties

_

build.noLangKeyword - Disable default lang keyword, e.g. `null`.

build.intermediateFolder

build.changesFile

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

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

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

ToolMatter

Your Apps in Action

Use this form to visualize A JSON schema for DocFx configuration files.

{{repoTitle.MainEntity}}

metadata Metadata section defines an array of source projects and their output folder.

_

_

_

_