{
  "$id": "https://webdoc.nyc3.digitaloceanspaces.com/schemas/v1/webdoc.conf.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Configure @webdoc/cli",
  "properties": {
    "opts": {
      "description": "Options for @webdoc/cli",
      "properties": {
        "destination": {
          "description": "Output folder for generated documentation",
          "type": "string"
        },
        "export": {
          "description": "Path to export document tree",
          "type": "string"
        },
        "import": {
          "description": "URIs to import document trees so template can link to referenced symbols",
          "type": "string"
        },
        "template": {
          "description": "Name of template to use (will be loaded using require() / import())",
          "type": "string"
        }
      },
      "type": "object"
    },
    "plugins": {
      "description": "List of plugins to generate",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "source": {
      "description": "Specify which files webdoc should run on",
      "properties": {
        "exclude": {
          "description": "List of source files / globs to exclude",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "excludePattern": {
          "description": "List of source file patterns / regular expressions to exclude",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "include": {
          "description": "List of source files / globs to include",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "includePattern": {
          "description": "List of source file patterns / regular expressions to include",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "template": {
      "description": "Options for @webdoc/default-template",
      "properties": {
        "alias": {
          "description": "Alias template files to override one of the default template files",
          "type": "object"
        },
        "appBar": {
          "description": "Options for app bar",
          "properties": {
            "items": {
              "additionalProperties": {
                "properties": {
                  "name": {
                    "description": "Label to show in app bar",
                    "type": "string"
                  },
                  "uri": {
                    "description": "Link to go to when clicking item",
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "description": "List of items to include in the app bar",
              "type": "object"
            }
          },
          "type": "object"
        },
        "applicationName": {
          "description": "Name / HTML for application to be shown in app bar or header",
          "type": "string"
        },
        "assets": {
          "description": "List of folders with assets to import, so they work with custom HTML in documents",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "integrations": {
          "description": "Untyped integrations to include in generated site",
          "type": "string"
        },
        "meta": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "List of meta key-value pairs to add in each HTML page",
          "type": "object"
        },
        "repository": {
          "description": "Repository link to use instead of generating HTML pages for source code",
          "type": "string"
        },
        "routes": {
          "description": "Overrides which route or URL generated docs go into",
          "properties": {
            "tutorials": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "siteDomain": {
          "description": "The website domain where you intend to publish the generated website.",
          "type": "string"
        },
        "siteRoot": {
          "description": "The root folder on the server where you'll put the generated site. This is used for absolute href links",
          "type": "string"
        },
        "sources": {
          "description": "Enable  or disable outputting source code",
          "type": "boolean"
        },
        "stylesheets": {
          "description": "List of stylesheets for CSS to include",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "title": {
          "description": "The HTML title for the site",
          "type": "string"
        },
        "variant": {
          "description": "Variant of template to generate (see template documentation)",
          "type": "string"
        }
      },
      "type": "object"
    },
    "version": {
      "description": "Version of webdoc configuration format being used",
      "type": "number"
    }
  },
  "title": "webdoc configuration format",
  "type": "object"
}