schema.json (5307B)
1 { 2 "$schema": "https://json-schema.org/draft-07/schema", 3 "title": "Material for MkDocs", 4 "markdownDescription": "Configuration", 5 "type": "object", 6 "properties": { 7 "INHERIT": { 8 "title": "Inherit from configuration", 9 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance", 10 "pattern": "\\.yml$" 11 }, 12 "site_name": { 13 "title": "Site name, used in header, title and drawer", 14 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_name", 15 "type": "string" 16 }, 17 "site_url": { 18 "title": "Site URL", 19 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_url", 20 "type": "string" 21 }, 22 "site_author": { 23 "title": "Site author, used in document head", 24 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_author", 25 "type": "string" 26 }, 27 "site_description": { 28 "title": "Site description, used in document head and in social cards", 29 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_description", 30 "type": "string" 31 }, 32 "repo_name": { 33 "title": "Repository name, used in header", 34 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-name", 35 "type": "string" 36 }, 37 "repo_url": { 38 "title": "Repository URL", 39 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository", 40 "type": "string" 41 }, 42 "edit_uri": { 43 "title": "Path from repository root to directory containing Markdown", 44 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#edit-button", 45 "type": "string" 46 }, 47 "copyright": { 48 "title": "Copyright, used in footer", 49 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#copyright-notice", 50 "type": "string" 51 }, 52 "docs_dir": { 53 "title": "Directory containing the Markdown sources", 54 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#docs_dir", 55 "type": "string", 56 "default": "docs" 57 }, 58 "site_dir": { 59 "title": "Directory containing the HTML output", 60 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_dir", 61 "type": "string", 62 "default": "site" 63 }, 64 "use_directory_urls": { 65 "title": "Pages are located in their own directories", 66 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#use_directory_urls", 67 "type": "boolean", 68 "default": false 69 }, 70 "extra_templates": { 71 "title": "Additional HTML files to include", 72 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates", 73 "type": "array", 74 "items": { 75 "title": "Path to HTML file", 76 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates", 77 "pattern": "\\.html$" 78 }, 79 "uniqueItems": true, 80 "minItems": 1 81 }, 82 "extra_css": { 83 "title": "Additional CSS files to include", 84 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css", 85 "type": "array", 86 "items": { 87 "title": "Path to CSS file", 88 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css", 89 "pattern": "\\.css($|\\?)" 90 }, 91 "uniqueItems": true, 92 "minItems": 1 93 }, 94 "extra_javascript": { 95 "title": "Additional JavaScript files to include", 96 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript", 97 "type": "array", 98 "items": { 99 "title": "Path to JavaScript file", 100 "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript", 101 "pattern": "\\.js($|\\?)" 102 }, 103 "uniqueItems": true, 104 "minItems": 1 105 }, 106 "strict": { 107 "title": "Strict mode", 108 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#strict", 109 "type": "boolean", 110 "default": false 111 }, 112 "dev_addr": { 113 "title": "Development IP Address", 114 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#dev_addr", 115 "type": "string", 116 "default": "127.0.0.1:8000" 117 }, 118 "remote_branch": { 119 "title": "Remote branch to deploy to", 120 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#remote_branch", 121 "type": "string", 122 "default": "gh-pages" 123 }, 124 "remote_name": { 125 "title": "Remote origin to deploy to", 126 "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#remote_name", 127 "type": "string", 128 "default": "origin" 129 }, 130 "theme": { 131 "$ref": "schema/theme.json" 132 }, 133 "plugins": { 134 "$ref": "schema/plugins.json" 135 }, 136 "markdown_extensions": { 137 "$ref": "schema/extensions.json" 138 }, 139 "extra": { 140 "$ref": "schema/extra.json" 141 }, 142 "nav": { 143 "$ref": "schema/nav.json" 144 } 145 }, 146 "additionalProperties": false 147 }