mkdocs-material/docs/schema/plugins/privacy.json

{
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Built-in privacy plugin",
  "oneOf": [
    {
      "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
      "enum": [
        "privacy"
      ]
    },
    {
      "type": "object",
      "properties": {
        "privacy": {
          "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin",
          "type": "object",
          "properties": {
            "enabled": {
              "title": "Enable plugin",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.enabled",
              "type": "boolean",
              "default": true
            },
            "concurrency": {
              "title": "Concurrency (number of CPUs)",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.concurrency",
              "type": "number",
              "default": 1
            },
            "external_assets": {
              "title": "External assets",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets",
              "oneOf": [
                {
                  "title": "Bundle external assets",
                  "enum": ["bundle"]
                },
                {
                  "title": "Report external assets as warnings",
                  "enum": ["report"]
                }
              ],
              "default": "bundle"
            },
            "external_assets_dir": {
              "title": "External assets download directory",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_dir",
              "type": "string",
              "default": "assets/external"
            },
            "external_assets_include": {
              "title": "External assets to include",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_include",
              "type": "array",
              "items": {
                "title": "External assets matching this pattern will be downloaded",
                "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_include",
                "pattern": ".*"
              },
              "uniqueItems": true,
              "minItems": 1
            },
            "external_assets_exclude": {
              "title": "External assets to exclude",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_exclude",
              "type": "array",
              "items": {
                "title": "External assets matching this pattern will not be downloaded",
                "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_exclude",
                "pattern": ".*"
              },
              "uniqueItems": true,
              "minItems": 1
            },
            "external_links": {
              "title": "External links",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_links",
              "type": "boolean",
              "default": true
            },
            "external_links_attr_map": {
              "title": "Custom attributes to add to external links",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_links_attr_map",
              "type": "object",
              "patternProperties": {
                "^[\\w_]+$": {
                  "type": "string"
                }
              }
            },
            "external_links_noopener": {
              "title": "Behavior for external links that open in new windows",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_links_noopener",
              "type": "boolean",
              "default": true
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  ]
}