Applies to: Version 0.5 and later
The behaviour of MdDocs can be customized by changing the configuration. Most settings are optional and MdDocs aims to use sensible default values or all of them.
Settings are loaded from a number of setting sources:
- Default settings
- Configuration file
- Execution parameters
- Commandline parameters in the case of the MdDocs .NET CLI Tool
- MSBuild properties in the case of the MdDocs MSBuild targets
The default settings are embedded in the MdDocs executable and apply, if no other source specifies a specific setting.
The default settings are defined in defaultSettings.json.
You can customize settings by placing them in a configuration file.
The configuration file is a JSON file and uses the same schema as defaultSettings.json.
A JSON Schema for the configuration file can be found at https://raw.githubusercontent.com/ap0llo/mddocs/master/schemas/configuration/schema.json.
The schema provides auto-completion support when editing the configuration file in editors that support JSON Schema (e.g. Visual Studio Code).
The use of a configuration file is optional.
You can specify the path of the configuration file using the configurationFilePath commandline parameter respectively the MdDocsConfigurationFilePath MSBuild property.
(see Commandline reference).
Setting names in the following table are separated by : which denote keys and sub-keys the JSON configuration file.
For example setting key:subkey to value would need to be specified in the configuration file like this:
{
"key" : {
"subkey" : "value"
}
}