This is part of the Fake.Documentation.DocFx module.
Metadata-Command parameters
| Record Field | Description |
Common
Signature: CommonParams
|
Specify common docFx options
|
ConfigFile
Signature: string
|
Specify the config file path.
|
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.
|
FilterConfigFile
Signature: string
|
Specify the filter config file.
|
ForceRebuild
Signature: bool
|
Force re-generate all the metadata.
|
GlobalNamespaceId
Signature: string
|
Specify the name to use for the global namespace.
|
LogParams
Signature: LogParams
|
Specify Logging parameter
|
MSBuildProperties
Signature: string
|
--property =;= An optional set of MSBuild properties used when interpreting project files. These are the same properties that are passed to msbuild via the /property:=;= command line argument.
|
OutputFolder
Signature: string
|
Specify the output base directory.
|
PreserveRawInlineComments
Signature: bool
|
Preserve the existing xml comment tags inside 'summary' triple slash comments.
|
Projects
Signature: string list
|
Specify project files.
|
ShouldSkipMarkup
Signature: bool
|
Skip to markup the triple slash comments.
|
| Instance member | Description |
x.WithCommon(f)
Signature: (f:(CommonParams -> CommonParams)) -> MetadataParams
Modifiers: inline
|
Changes the "Common" parameters according to the given function
|
x.WithLogParams(f)
Signature: (f:(LogParams -> LogParams)) -> MetadataParams
Modifiers: inline
|
Changes the "LogParams" according to the given function
|
| Static member | Description |
MetadataParams.Create()
Signature: unit -> MetadataParams
|
Metadata default parameters
|