@nx-dotnet/nxdoc/src/generators/generate-docs/schema.json

> This package is unstable! Documentation formatting could change in the future. See something that you think should be different? [Open an issue](https://github.com/nx-dotnet/nx-dotnet/issues) on github and help shape this plugin.

{
  "id": "generate-docs",
  "type": "object",
  "properties": {
    "outputDirectory": {
      "type": "string",
      "description": "Where should the generated docs be placed?",
      "default": "docs"
    },
    "gettingStartedFile": {
      "type": "string",
      "description": "File contents to place before the API reference section for each package. <src> is replaced by the package's root.",
      "default": "<src>/README.md"
    },
    "skipFrontMatter": {
      "type": "boolean",
      "description": "Nxdoc generates frontmatter suitable for docusaurus by default.",
      "default": false
    },
    "skipFormat": {
      "type": "boolean",
      "description": "Skips running the output through prettier",
      "default": false
    },
    "verboseLogging": {
      "type": "boolean",
      "description": "Print some additional logs during doc generation",
      "default": false
    },
    "exclude": {
      "description": "Projects that should not be included in documentation",
      "oneOf": [
        {
          "type": "string",
          "description": "A comma separated list of projects that should not be included in documentation"
        },
        {
          "type": "array",
          "description": "An array of projects that should not be included in documentation",
          "items": {
            "type": "string"
          }
        }
      ]
    }
  },
  "required": ["outputDirectory"]
}