Skip to content

Configuration

Everything you can configure for bdoctor lives in two places: the arguments you pass to a command, and the bdoctor.json file in the root of your project. Both use the same names, so an option you know from the command line can be moved to the configuration file, and the other way around.

Command arguments bdoctor.json
Example bdoctor publish --url <url> { "url": "<url>" }
Best for Secrets and one-off runs Everything which stays the same on every run
Scope The command you are running All commands in the project

bdoctor init creates the bdoctor.json file for you, so you usually only need to pass the certificate (and its password) on each run.

  • CLI options: every argument you can pass to a bdoctor command, grouped per authentication, all commands, and the publish command.
  • bdoctor.json: the settings which are configured as objects in the configuration file, like multilingual, site design, markdown rendering, partials, and the static navigation.
{
"$schema": "https://cloud13.blob.core.windows.net/public/bdoctor/schema/2.4.0.json",
"url": "https://<tenant>.sharepoint.com/sites/<documentation>",
"appId": "<appId>",
"tenant": "<tenant>",
"folder": "./src"
}