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

{
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Built-in social plugin",
  "oneOf": [
    {
      "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin",
      "enum": [
        "social"
      ]
    },
    {
      "type": "object",
      "properties": {
        "social": {
          "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#built-in-social-plugin",
          "type": "object",
          "properties": {
            "enabled": {
              "title": "Enable plugin",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.enabled",
              "type": "boolean",
              "default": true
            },
            "concurrency": {
              "title": "Concurrency (number of CPUs)",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.concurrency",
              "type": "number",
              "default": 1
            },
            "cards": {
              "title": "Social cards",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards",
              "type": "boolean",
              "default": true
            },
            "cards_dir": {
              "title": "Social cards directory",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_dir",
              "type": "string",
              "default": "assets/images/social"
            },
            "cards_layout_dir": {
              "title": "Social cards layout directory",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_layout_dir",
              "type": "string",
              "default": "layouts"
            },
            "cards_layout": {
              "title": "Social cards layout",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_layout",
              "default": "default",
              "enum": [
                "default",
                "default/accent",
                "default/invert",
                "default/variant"
              ]
            },
            "cards_layout_options": {
              "title": "Social cards layout options",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_layout_options",
              "type": "object"
            },
            "cards_include": {
              "title": "Pages or folders to include",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_include",
              "type": "array",
              "items": {
                "title": "Pages or folders matching this pattern will be included",
                "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_include",
                "pattern": ".*"
              },
              "uniqueItems": true,
              "minItems": 1
            },
            "cards_exclude": {
              "title": "Pages or folders to exclude",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_exclude",
              "type": "array",
              "items": {
                "title": "Pages or folders matching this pattern will be excluded",
                "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_exclude",
                "pattern": ".*"
              },
              "uniqueItems": true,
              "minItems": 1
            },
            "debug": {
              "title": "Debug mode",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug",
              "type": "boolean",
              "default": true
            },
            "debug_on_build": {
              "title": "Always disable debug mode on build",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_on_build",
              "type": "boolean",
              "default": false
            },
            "debug_grid": {
              "title": "Debug grid",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_grid",
              "type": "boolean",
              "default": true
            },
            "debug_grid_step": {
              "title": "Debug grid step size",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_grid_step",
              "type": "number",
              "default": 32
            },
            "debug_color": {
              "title": "Debug color",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.debug_color",
              "type": "string",
              "default": "yellow"
            },
            "cache": {
              "title": "Enable caching",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cache",
              "type": "boolean",
              "default": true
            },
            "cache_dir": {
              "title": "Cache directory",
              "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cache_dir",
              "type": "string",
              "default": ".cache/plugins/social"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  ]
}