Class BuildConfig
- Namespace
- DocFxHelper
- Assembly
- DocBuilder.dll
Controls what gets built See: https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html#32-properties-for-build
public class BuildConfig- Inheritance
-
BuildConfig
- Inherited Members
Properties
cleanupCacheHistory
Included for structure and default DocFx behavior
public bool cleanupCacheHistory { get; set; }Property Value
content
Contains all the files to generate documentation, including metadata yml files and conceptual md files. name-files file mapping with several ways to define it, as to be described in Section4. The files contains all the project files to have API generated.
public List<BuildContent> content { get; set; }Property Value
dest
Output destination - set to _site by the POSH module
public string dest { get; set; }Property Value
fileMetadataFiles
Included for structure and default DocFx behavior
public List<string> fileMetadataFiles { get; set; }Property Value
globalMetadataFiles
Included for structure and default DocFx behavior
public List<string> globalMetadataFiles { get; set; }Property Value
keepFileLink
Included for structure and default DocFx behavior
public bool keepFileLink { get; set; }Property Value
noLangKeyword
Included for structure and default DocFx behavior
public bool noLangKeyword { get; set; }Property Value
overwrite
Included for structure and default DocFx behavior
public List<BuildContent> overwrite { get; set; }Property Value
postProcessors
Included for structure and default DocFx behavior
public List<string> postProcessors { get; set; }Property Value
resource
Contains all the resource files that conceptual and metadata files dependent on, e.g. image files. name-files file mapping with several ways to define it, as to be described in Section4.
public List<BuildContent> resource { get; set; }Property Value
template
The templates applied to each file in the documentation. 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, embedded default template will be used.
public List<string> template { get; set; }