| 1 | {
|
| 2 | "title": "API Documenter Configuration",
|
| 3 | "description": "Describes how the API Documenter tool will process a project.",
|
| 4 | "type": "object",
|
| 5 | "properties": {
|
| 6 | "$schema": {
|
| 7 | "description": "Part of the JSON Schema standard, this optional keyword declares the URL of the schema that the file conforms to. Editors may download the schema and use it to perform syntax highlighting.",
|
| 8 | "type": "string"
|
| 9 | },
|
| 10 |
|
| 11 | "outputTarget": {
|
| 12 | "description": "Specifies what type of documentation will be generated",
|
| 13 | "type": "string",
|
| 14 | "enum": ["docfx", "markdown"]
|
| 15 | },
|
| 16 |
|
| 17 | "newlineKind": {
|
| 18 | "description": "Specifies what type of newlines API Documenter should use when writing output files. By default, the output files will be written with Windows-style newlines. To use POSIX-style newlines, specify \"lf\" instead. To use the OS's default newline kind, specify \"os\".",
|
| 19 | "type": "string",
|
| 20 | "enum": ["crlf", "lf", "os"],
|
| 21 | "default": "crlf"
|
| 22 | },
|
| 23 |
|
| 24 | "newDocfxNamespaces": {
|
| 25 | "description": "This enables an experimental feature that will be officially released with the next major version of API Documenter. It requires DocFX 2.46 or newer. It enables documentation for namespaces and adds them to the table of contents. This will also affect file layout as namespaced items will be nested under a directory for the namespace instead of just within the package.",
|
| 26 | "type": "boolean"
|
| 27 | },
|
| 28 |
|
| 29 | "plugins": {
|
| 30 | "description": "Specifies plugin packages to be loaded",
|
| 31 | "type": "array"
|
| 32 | },
|
| 33 |
|
| 34 | "tableOfContents": {
|
| 35 | "description": "Configures how the table of contents is generated.",
|
| 36 | "type": "object",
|
| 37 | "additionalProperties": true
|
| 38 | }
|
| 39 | },
|
| 40 |
|
| 41 | "additionalProperties": false
|
| 42 | }
|