extra.json (13047B)
1 { 2 "$schema": "https://json-schema.org/draft-07/schema", 3 "title": "Extra configuration", 4 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/", 5 "type": "object", 6 "properties": { 7 "homepage": { 8 "title": "Homepage link (when clicking on logo)", 9 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo", 10 "type": "string" 11 }, 12 "analytics": { 13 "title": "Analytics provider", 14 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", 15 "type": "object", 16 "properties": { 17 "provider": { 18 "title": "Analytics provider", 19 "oneOf": [ 20 { 21 "title": "Google Analytics", 22 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", 23 "enum": [ 24 "google" 25 ] 26 }, 27 { 28 "type": "string" 29 } 30 ] 31 }, 32 "property": { 33 "oneOf": [ 34 { 35 "title": "Google Analytics 4", 36 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", 37 "pattern": "^G-\\w{10}$" 38 }, 39 { 40 "title": "Universal Analytics", 41 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", 42 "pattern": "^UA-\\w{9}-\\w$" 43 }, 44 { 45 "title": "Unknown property", 46 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", 47 "type": "string" 48 } 49 ] 50 }, 51 "feedback": { 52 "title": "Was this page helpful?", 53 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", 54 "type": "object", 55 "properties": { 56 "title": { 57 "title": "Feedback widget title", 58 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", 59 "type": "string", 60 "default": "Was this page helpful?" 61 }, 62 "ratings": { 63 "title": "Feedback ratings", 64 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", 65 "type": "array", 66 "items": { 67 "title": "Feedback rating", 68 "type": "object", 69 "properties": { 70 "icon": { 71 "$ref": "#/definitions/icon" 72 }, 73 "name": { 74 "title": "Feedback rating name", 75 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-name", 76 "type": "string" 77 }, 78 "data": { 79 "title": "Feedback rating data", 80 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-data", 81 "type": "number" 82 }, 83 "note": { 84 "title": "Feedback rating data", 85 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-note", 86 "type": "string" 87 } 88 }, 89 "additionalProperties": false, 90 "required": [ 91 "icon", 92 "name", 93 "data", 94 "note" 95 ] 96 } 97 } 98 }, 99 "additionalProperties": false, 100 "required": [ 101 "title" 102 ] 103 } 104 }, 105 "additionalProperties": false, 106 "required": [ 107 "provider", 108 "property" 109 ], 110 "defaultSnippets": [ 111 { 112 "label": "feedback (default)", 113 "body": { 114 "feedback": { 115 "title": "${1:Was this page helpful}", 116 "ratings": [ 117 { 118 "icon": "${2:material/emoticon-happy-outline}", 119 "name": "${3:This page was helpful}", 120 "data": 1, 121 "note": "${4:Thanks for your feedback!}" 122 }, 123 { 124 "icon": "${5:material/emoticon-sad-outline}", 125 "name": "${6:This page could be improved}", 126 "data": 0, 127 "note": "${7:Thanks for your feedback!}" 128 } 129 ] 130 } 131 } 132 } 133 ] 134 }, 135 "consent": { 136 "title": "Cookie consent", 137 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 138 "type": "object", 139 "properties": { 140 "title": { 141 "title": "Cookie consent title", 142 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 143 "type": "string", 144 "default": "Cookie consent" 145 }, 146 "description": { 147 "title": "Cookie consent description", 148 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 149 "type": "string" 150 }, 151 "cookies": { 152 "title": "Cookies", 153 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 154 "type": "object", 155 "properties": { 156 "analytics": { 157 "$ref": "#/definitions/cookie" 158 } 159 }, 160 "patternProperties": { 161 "\\w+": { 162 "$ref": "#/definitions/cookie" 163 } 164 }, 165 "additionalProperties": false, 166 "defaultSnippets": [ 167 { 168 "label": "analytics (default)", 169 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 170 "body": { 171 "analytics": { 172 "name": "Google Analytics", 173 "checked": true 174 } 175 } 176 } 177 ] 178 }, 179 "actions": { 180 "title": "Cookie consent actions", 181 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 182 "type": "array", 183 "items": { 184 "oneOf": [ 185 { 186 "title": "Button to accept cookies", 187 "enum": [ 188 "accept" 189 ] 190 }, 191 { 192 "title": "Button to reject cookies", 193 "enum": [ 194 "reject" 195 ] 196 }, 197 { 198 "title": "Button to manage settings", 199 "enum": [ 200 "manage" 201 ] 202 } 203 ] 204 } 205 } 206 }, 207 "additionalProperties": false, 208 "defaultSnippets": [ 209 { 210 "label": "actions (default)", 211 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 212 "body": { 213 "actions": [ 214 "accept", 215 "manage" 216 ] 217 } 218 } 219 ], 220 "required": [ 221 "title", 222 "description" 223 ] 224 }, 225 "social": { 226 "title": "Social links", 227 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links", 228 "type": "array", 229 "items": { 230 "title": "Social link", 231 "type": "object", 232 "properties": { 233 "icon": { 234 "$ref": "#/definitions/icon" 235 }, 236 "link": { 237 "title": "Social link", 238 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-link", 239 "type": "string" 240 }, 241 "name": { 242 "title": "Social link name", 243 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-name", 244 "type": "string" 245 } 246 }, 247 "additionalProperties": false, 248 "required": [ 249 "icon", 250 "link" 251 ] 252 } 253 }, 254 "alternate": { 255 "title": "Site language selector", 256 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector", 257 "type": "array", 258 "items": { 259 "title": "Alternate language", 260 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector", 261 "type": "object", 262 "properties": { 263 "name": { 264 "title": "Alternate language name", 265 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-name", 266 "type": "string" 267 }, 268 "link": { 269 "title": "Alternate language link", 270 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-link", 271 "type": "string" 272 }, 273 "lang": { 274 "title": "Alternate language code (ISO 639-1)", 275 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-lang", 276 "type": "string" 277 } 278 }, 279 "additionalProperties": false, 280 "required": [ 281 "name", 282 "link", 283 "lang" 284 ] 285 } 286 }, 287 "tags": { 288 "title": "Tag identifiers", 289 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons", 290 "type": "object", 291 "patternProperties": { 292 ".*": { 293 "title": "Tag identifier mapping", 294 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons", 295 "pattern": "^[\\w-]+$" 296 } 297 } 298 }, 299 "version": { 300 "title": "Versioning", 301 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning", 302 "type": "object", 303 "properties": { 304 "provider": { 305 "title": "Versioning provider", 306 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning", 307 "enum": [ 308 "mike" 309 ] 310 }, 311 "default": { 312 "title": "Default version", 313 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning", 314 "default": "stable" 315 } 316 } 317 }, 318 "generator": { 319 "title": "Generator notice", 320 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice", 321 "type": "boolean", 322 "default": true 323 } 324 }, 325 "additionalProperties": true, 326 "definitions": { 327 "cookie": { 328 "title": "Cookie", 329 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 330 "oneOf": [ 331 { 332 "type": "object", 333 "properties": { 334 "name": { 335 "title": "Cookie name", 336 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 337 "type": "string" 338 }, 339 "checked": { 340 "title": "Initial state", 341 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 342 "type": "boolean", 343 "default": true 344 } 345 }, 346 "additionalProperties": false, 347 "required": [ 348 "name" 349 ] 350 }, 351 { 352 "title": "Cookie name", 353 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", 354 "type": "string" 355 } 356 ] 357 }, 358 "icon": { 359 "oneOf": [ 360 { 361 "$ref": "assets/icons.json" 362 }, 363 { 364 "title": "Unknown icon", 365 "type": "string" 366 } 367 ] 368 } 369 }, 370 "defaultSnippets": [ 371 { 372 "label": "analytics (default)", 373 "body": { 374 "analytics": { 375 "provider": "${1:google}", 376 "property": "${2:UA-XXXXXXXX-X}" 377 } 378 } 379 } 380 ] 381 }