Options can be set in the following ways:

  • inline (for CLI), as a JSON object (wrapped with { & })

    typedoc --<pluginOptionsPrefix> '{"source": "my-source"}'
    
  • as a path to a configuration file exporting options (requireable files are supported, so, by default, .json & .js)

    typedoc --<pluginOptionsPrefix> plugin-configuration.json
    

From typedoc.json

  {
// ...
"<pluginOptionsPrefix>": "plugin-configuration.json"
}
  • as individual options (prefixed with <pluginOptionsPrefix>:)

    typedoc --<pluginOptionsPrefix>:<optionName> <optionValue>
    

From typedoc.json

  {
// ...
"<pluginOptionsPrefix>:<optionName>": "<optionValue>"
}
  • or as an object (for config file only)

From typedoc.json

  {
// ...
"<pluginOptionsPrefix>": {
"<optionName>": "<optionValue>"
}
}

Generated using TypeDoc