bunny-lab/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial Commit

Browse Source 
Bringing Documentation into Gitea
This commit is contained in:
Nicole Rappe
2023-12-21 01:15:09 -07:00
commit b9aeaabbfb
90 changed files with 26956 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7050
schema/assets/fonts.json Normal file
View File

File diff suppressed because it is too large Load Diff

12668
schema/assets/icons.json Normal file
View File

File diff suppressed because it is too large Load Diff

18
schema/extensions.json Normal file
View File

@ -0,0 +1,18 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Markdown extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "extensions/markdown.json"
},
{
"$ref": "extensions/pymdownx.json"
}
]
},
"uniqueItems": true,
"minItems": 1
}

148
schema/extensions/markdown.json Normal file
View File

@ -0,0 +1,148 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Markdown extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/",
"oneOf": [
{
"title": "Abbreviations – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#abbreviations",
"enum": [
"markdown.extensions.abbr",
"abbr"
]
},
{
"title": "Admonition – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition",
"enum": [
"markdown.extensions.admonition",
"admonition"
]
},
{
"title": "Attribute Lists – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists",
"enum": [
"markdown.extensions.attr_list",
"attr_list"
]
},
{
"title": "Markdown extension: a classier syntax for admonitions",
"markdownDescription": "https://github.com/oprypin/markdown-callouts",
"enum": [
"markdown.extensions.callouts",
"callouts"
]
},
{
"title": "Definition Lists – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#definition-lists",
"enum": [
"markdown.extensions.def_list",
"def_list"
]
},
{
"title": "Footnotes – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes",
"enum": [
"markdown.extensions.footnotes",
"footnotes"
]
},
{
"title": "Markdown in HTML – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html",
"enum": [
"markdown.extensions.md_in_html",
"md_in_html"
]
},
{
"title": "Tables – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#tables",
"enum": [
"markdown.extensions.tables",
"tables"
]
},
{
"oneOf": [
{
"type": "object",
"properties": {
"toc": {
"$ref": "#/definitions/toc"
},
"markdown.extensions.toc": {
"$ref": "#/definitions/toc"
}
},
"additionalProperties": false
},
{
"title": "Table Of Contents – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents",
"enum": [
"markdown.extensions.toc",
"toc"
]
}
]
}
],
"definitions": {
"toc": {
"title": "Table Of Contents – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents",
"type": "object",
"properties": {
"title": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.title",
"type": "string"
},
"permalink": {
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink",
"type": "boolean"
},
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink",
"type": "string"
}
],
"default": true
},
"anchorlink": {
"markdownDescription": "https://python-markdown.github.io/extensions/toc/#usage",
"type": "boolean",
"default": false
},
"permalink_title": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink_title",
"type": "string"
},
"slugify": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.slugify",
"default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
},
"toc_depth": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.toc_depth",
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6
]
}
},
"additionalProperties": false
}
}
}

733
schema/extensions/pymdownx.json Normal file
View File

@ -0,0 +1,733 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Markdown extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/",
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"pymdownx.arithmatex": {
"title": "Arithmatex – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex",
"type": "object",
"properties": {
"generic": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/#options",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"title": "Arithmatex – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex",
"enum": [
"pymdownx.arithmatex"
]
}
]
},
{
"oneOf": [
{
"type": "object",
"properties": {
"pymdownx.betterem": {
"title": "BetterEm – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem",
"type": "object",
"properties": {
"smart_enable": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/betterem/#options",
"type": "string",
"enum": [
"all",
"asterisk",
"underscore",
"none"
],
"default": "all"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"title": "BetterEm – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem",
"enum": [
"pymdownx.betterem"
]
}
]
},
{
"oneOf": [
{
"title": "Caret – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
"enum": [
"pymdownx.caret"
]
},
{
"type": "object",
"properties": {
"pymdownx.caret": {
"title": "Caret – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
"type": "object",
"properties": {
"smart_insert": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/caret/#options",
"type": "boolean",
"default": true
},
"insert": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/caret/#options",
"type": "boolean",
"default": true
},
"superscript": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/caret/#options",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"title": "Critic – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic",
"enum": [
"pymdownx.critic"
]
},
{
"type": "object",
"properties": {
"pymdownx.critic": {
"title": "Critic – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic",
"type": "object",
"properties": {
"mode": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.critic.mode",
"enum": [
"view",
"accept",
"reject"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"title": "Details – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details",
"enum": [
"pymdownx.details"
]
},
{
"oneOf": [
{
"title": "Emoji – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji",
"enum": [
"pymdownx.emoji"
]
},
{
"type": "object",
"properties": {
"pymdownx.emoji": {
"title": "Emoji – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji",
"type": "object",
"properties": {
"emoji_generator": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator",
"default": "!!python/name:material.extensions.emoji.to_svg"
},
"emoji_index": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index",
"default": "!!python/name:material.extensions.emoji.twemoji"
},
"options": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
"type": "object",
"properties": {
"custom_icons": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
"type": "array",
"items": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
"type": "string"
},
"uniqueItems": true,
"minItems": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"emoji_generator",
"emoji_index"
]
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"title": "Highlight – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight",
"enum": [
"pymdownx.highlight"
]
},
{
"type": "object",
"properties": {
"pymdownx.highlight": {
"title": "Highlight – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight",
"type": "object",
"properties": {
"use_pygments": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.use_pygments",
"type": "boolean"
},
"pygments_lang_class": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.pygments_lang_class",
"type": "boolean"
},
"auto_title": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.auto_title",
"type": "boolean"
},
"auto_title_map": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/highlight/#options",
"type": "object"
},
"linenums": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums",
"type": "boolean"
},
"linenums_style": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums_style",
"enum": [
"inline",
"pymdownx-inline",
"table"
]
},
"anchor_linenums": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.anchor_linenums",
"type": "boolean"
},
"line_spans": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.line_spans",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"title": "InlineHilite – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite",
"enum": [
"pymdownx.inlinehilite"
]
},
{
"oneOf": [
{
"title": "Keys – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys",
"enum": [
"pymdownx.keys"
]
},
{
"type": "object",
"properties": {
"pymdownx.keys": {
"title": "Keys – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys",
"type": "object",
"properties": {
"separator": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
"type": "string",
"default": "+"
},
"strict": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
"type": "boolean",
"default": false
},
"camel_case": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
"type": "boolean",
"default": false
},
"key_map": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
"type": "object"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"title": "MagicLink – Python Markdown Extensions",
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/",
"enum": [
"pymdownx.magiclink"
]
},
{
"type": "object",
"properties": {
"pymdownx.magiclink": {
"title": "MagicLink – Python Markdown Extensions",
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/",
"type": "object",
"properties": {
"hide_protocol":{
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "boolean",
"default": false
},
"labels": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#labels",
"type": "object",
"default": {
"commit": "Commit",
"compare": "Compare",
"issue": "Issue",
"pull": "Pull Request",
"mention": "User",
"repository": "Repository"
}
},
"normalize_issue_symbols": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "boolean",
"default": false
},
"user": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "string",
"default": ""
},
"provider": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "string",
"default": "github"
},
"repo": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "string",
"repo": ""
},
"repo_url_shorthand": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "boolean",
"default": true
},
"repo_url_shortener": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "boolean",
"default": false
},
"social_url_shorthand": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "boolean",
"default": false
},
"social_url_shortener": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#options",
"type": "boolean",
"default": false
},
"shortener_user_exclude": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/#user-excludes",
"type": "object"
}
},
"additionalProperties": false,
"required": [
"user",
"repo"
]
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"title": "Mark – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
"enum": [
"pymdownx.mark"
]
},
{
"type": "object",
"properties": {
"pymdownx.mark": {
"title": "Mark – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
"type": "object",
"properties": {
"smart_mark": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"title": "SmartSymbols – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols",
"enum": [
"pymdownx.smartsymbols"
]
},
{
"type": "object",
"properties": {
"pymdownx.smartsymbols": {
"title": "SmartSymbols – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols",
"type": "object",
"properties": {
"trademark": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"copyright": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"registered": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"care_of": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"plusminus": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"arrows": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"notequal": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"fractions": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
},
"ordinal_numbers": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"type": "object",
"properties": {
"pymdownx.snippets": {
"title": "Snippets – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets",
"type": "object",
"properties": {
"base_path": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "array",
"items": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "string"
},
"uniqueItems": true,
"minItems": 1
},
"auto_append": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "array",
"items": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "string"
},
"uniqueItems": true,
"minItems": 1
},
"check_paths": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "boolean",
"default": true
},
"url_download": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "boolean",
"default": false
},
"url_max_size": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "integer",
"default": 33554432
},
"url_timeout": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "number",
"default": 10.0
},
"url_request_headers": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#options",
"type": "object",
"default": {}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"title": "Snippets – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets",
"enum": [
"pymdownx.snippets"
]
}
]
},
{
"oneOf": [
{
"title": "SuperFences – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences",
"enum": [
"pymdownx.superfences"
]
},
{
"type": "object",
"properties": {
"pymdownx.superfences": {
"title": "SuperFences – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences",
"type": "object",
"properties": {
"custom_fences": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences",
"type": "array",
"items": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences",
"type": "object",
"properties": {
"name": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/superfences/#custom-fences",
"type": "string"
},
"class": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/superfences/#custom-fences",
"type": "string"
},
"format": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/superfences/#custom-fences",
"type": "string"
}
},
"additionalProperties": false
},
"minItems": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"pymdownx.tabbed": {
"title": "Tabbed – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed",
"type": "object",
"properties": {
"alternate_style": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.alternate_style",
"type": "boolean",
"enum": [
true
],
"default": true
},
"combine_header_slug": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.combine_header_slug",
"type": "boolean",
"default": true
},
"slugify": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.slugify",
"default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
}
},
"additionalProperties": false,
"required": [
"alternate_style"
]
}
},
"additionalProperties": false
},
{
"oneOf": [
{
"title": "Tasklist – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist",
"enum": [
"pymdownx.tasklist"
]
},
{
"type": "object",
"properties": {
"pymdownx.tasklist": {
"title": "Tasklist – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist",
"type": "object",
"properties": {
"custom_checkbox": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.custom_checkbox",
"type": "boolean",
"default": true
},
"clickable_checkbox": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.clickable_checkbox",
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
{
"oneOf": [
{
"title": "Tilde – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
"enum": [
"pymdownx.tilde"
]
},
{
"type": "object",
"properties": {
"pymdownx.tilde": {
"title": "Tilde – Python Markdown Extensions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde",
"type": "object",
"properties": {
"smart_delete": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/tilde/#options",
"type": "boolean"
},
"delete": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/tilde/#options",
"type": "boolean"
},
"subscript": {
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/tilde/#options",
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}
]
}

422
schema/extra.json Normal file
View File

@ -0,0 +1,422 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Extra configuration",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/",
"type": "object",
"properties": {
"homepage": {
"title": "Homepage link (when clicking on logo)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo",
"type": "string"
},
"analytics": {
"title": "Analytics provider",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"type": "object",
"properties": {
"provider": {
"title": "Analytics provider",
"anyOf": [
{
"title": "Google Analytics",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"enum": [
"google"
]
},
{
"type": "string"
}
]
},
"property": {
"anyOf": [
{
"title": "Google Analytics 4",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"pattern": "^G-\\w{10}$"
},
{
"title": "Universal Analytics",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"pattern": "^UA-\\w{9}-\\w$"
},
{
"title": "Unknown property",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics",
"type": "string"
}
]
},
"feedback": {
"title": "Was this page helpful?",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
"type": "object",
"properties": {
"title": {
"title": "Feedback widget title",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
"type": "string",
"default": "Was this page helpful?"
},
"ratings": {
"title": "Feedback ratings",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful",
"type": "array",
"items": {
"title": "Feedback rating",
"type": "object",
"properties": {
"icon": {
"$ref": "#/definitions/icon"
},
"name": {
"title": "Feedback rating name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.name",
"type": "string"
},
"data": {
"title": "Feedback rating data",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.data",
"type": "number"
},
"note": {
"title": "Feedback rating data",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.note",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"icon",
"name",
"data",
"note"
]
}
}
},
"additionalProperties": false,
"required": [
"title"
]
}
},
"additionalProperties": false,
"required": [
"provider",
"property"
],
"defaultSnippets": [
{
"label": "feedback (default)",
"body": {
"feedback": {
"title": "${1:Was this page helpful}",
"ratings": [
{
"icon": "${2:material/emoticon-happy-outline}",
"name": "${3:This page was helpful}",
"data": 1,
"note": "${4:Thanks for your feedback!}"
},
{
"icon": "${5:material/emoticon-sad-outline}",
"name": "${6:This page could be improved}",
"data": 0,
"note": "${7:Thanks for your feedback!}"
}
]
}
}
}
]
},
"annotate": {
"title": "Custom selectors for annotations",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-selectors",
"type": "object",
"patternProperties": {
".*": {
"title": "Custom selector",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-selectors",
"type": "array",
"items": {
"type": "string",
"pattern": "^\\.\\w+"
}
}
}
},
"consent": {
"title": "Cookie consent",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "object",
"properties": {
"title": {
"title": "Cookie consent title",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.title",
"type": "string",
"default": "Cookie consent"
},
"description": {
"title": "Cookie consent description",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.description",
"type": "string"
},
"cookies": {
"title": "Cookies",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
"type": "object",
"properties": {
"analytics": {
"$ref": "#/definitions/cookie"
},
"github": {
"$ref": "#/definitions/cookie"
}
},
"patternProperties": {
"\\w+": {
"$ref": "#/definitions/cookie"
}
},
"additionalProperties": false,
"defaultSnippets": [
{
"label": "analytics (default)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
"body": {
"analytics": {
"name": "Google Analytics",
"checked": true
}
}
},
{
"label": "github (default)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
"body": {
"analytics": {
"name": "GitHub",
"checked": true
}
}
}
]
},
"actions": {
"title": "Cookie consent actions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions",
"type": "array",
"items": {
"oneOf": [
{
"title": "Button to accept cookies",
"enum": [
"accept"
]
},
{
"title": "Button to reject cookies",
"enum": [
"reject"
]
},
{
"title": "Button to manage settings",
"enum": [
"manage"
]
}
]
},
"uniqueItems": true
}
},
"additionalProperties": false,
"defaultSnippets": [
{
"label": "actions (default)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions",
"body": {
"actions": [
"accept",
"manage"
]
}
}
],
"required": [
"title",
"description"
]
},
"social": {
"title": "Social links",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links",
"type": "array",
"items": {
"title": "Social link",
"type": "object",
"properties": {
"icon": {
"$ref": "#/definitions/icon"
},
"link": {
"title": "Social link",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.link",
"type": "string"
},
"name": {
"title": "Social link name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"icon",
"link"
]
}
},
"alternate": {
"title": "Site language selector",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector",
"type": "array",
"items": {
"title": "Alternate language",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector",
"type": "object",
"properties": {
"name": {
"title": "Alternate language name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.name",
"type": "string"
},
"link": {
"title": "Alternate language link",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.link",
"type": "string"
},
"lang": {
"title": "Alternate language code (ISO 639-1)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.lang",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"link",
"lang"
]
}
},
"tags": {
"title": "Tag identifiers",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers",
"type": "object",
"patternProperties": {
".*": {
"title": "Tag identifier mapping",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers",
"pattern": "^[\\w-]+$"
}
}
},
"version": {
"title": "Versioning",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning",
"type": "object",
"properties": {
"provider": {
"title": "Versioning provider",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning",
"enum": [
"mike"
]
},
"default": {
"title": "Default version",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"default": "stable"
}
}
},
"generator": {
"title": "Generator notice",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice",
"type": "boolean",
"default": true
}
},
"additionalProperties": true,
"definitions": {
"cookie": {
"title": "Cookie",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"title": "Cookie name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "string"
},
"checked": {
"title": "Initial state",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "boolean",
"default": true
}
},
"additionalProperties": false,
"required": [
"name"
]
},
{
"title": "Cookie name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
"type": "string"
}
]
},
"icon": {
"anyOf": [
{
"$ref": "assets/icons.json"
},
{
"title": "Unknown icon",
"type": "string"
}
]
}
},
"defaultSnippets": [
{
"label": "analytics (default)",
"body": {
"analytics": {
"provider": "${1:google}",
"property": "${2:UA-XXXXXXXX-X}"
}
}
}
]
}

34
schema/nav.json Normal file
View File

@ -0,0 +1,34 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Navigation tree",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"type": "array",
"items": {
"anyOf": [
{
"title": "Navigation item",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"pattern": "\\.md$"
},
{
"type": "object",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"patternProperties": {
".*": {
"oneOf": [
{
"title": "Navigation item",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav",
"pattern": "\\.md$"
},
{
"$ref": "#"
}
]
}
}
}
]
},
"additionalItems": false
}

131
schema/plugins.json Normal file
View File

@ -0,0 +1,131 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Plugins",
"markdownDescription": "https://www.mkdocs.org/dev-guide/plugins/",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/built-in"
},
{
"$ref": "#/definitions/external"
},
{
"$ref": "#/definitions/external-community"
}
]
},
"uniqueItems": true,
"minItems": 1,
"definitions": {
"built-in": {
"description": "Built-in plugins",
"anyOf": [
{
"$ref": "plugins/blog.json"
},
{
"$ref": "plugins/group.json"
},
{
"$ref": "plugins/info.json"
},
{
"$ref": "plugins/meta.json"
},
{
"$ref": "plugins/offline.json"
},
{
"$ref": "plugins/optimize.json"
},
{
"$ref": "plugins/privacy.json"
},
{
"$ref": "plugins/projects.json"
},
{
"$ref": "plugins/search.json"
},
{
"$ref": "plugins/social.json"
},
{
"$ref": "plugins/tags.json"
},
{
"$ref": "plugins/typeset.json"
}
]
},
"external": {
"description": "External plugins, schema provided by us",
"anyOf": [
{
"$ref": "plugins/external/gen-files.json"
},
{
"$ref": "plugins/external/git-authors.json"
},
{
"$ref": "plugins/external/git-committers.json"
},
{
"$ref": "plugins/external/git-revision-date.json"
},
{
"$ref": "plugins/external/literate-nav.json"
},
{
"$ref": "plugins/external/macros.json"
},
{
"$ref": "plugins/external/minify.json"
},
{
"$ref": "plugins/external/redirects.json"
},
{
"$ref": "plugins/external/section-index.json"
}
]
},
"external-community": {
"description": "External plugins, schema provided by our community",
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/mondeja/mkdocs-include-markdown-plugin/master/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/mondeja/mkdocs-material-relative-language-selector/master/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/Guts/mkdocs-rss-plugin/main/docs/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/timvink/mkdocs-git-revision-date-localized-plugin/master/docs/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/blueswen/mkdocs-glightbox/main/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/prcr/mkdocs-meta-descriptions-plugin/main/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/mkdocstrings/mkdocstrings/master/docs/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/pawamoy/mkdocs-coverage/master/docs/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/pawamoy/mkdocs-spellcheck/master/docs/schema.json"
},
{
"$ref": "https://raw.githubusercontent.com/pawamoy/markdown-exec/master/docs/schema.json"
}
]
}
}
}

365
schema/plugins/blog.json Normal file
View File

@ -0,0 +1,365 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in blog plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/",
"enum": [
"blog"
]
},
{
"type": "object",
"properties": {
"blog": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.enabled",
"type": "boolean",
"default": true
},
"blog_dir": {
"title": "Blog directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_dir",
"type": "string",
"default": "blog"
},
"blog_toc": {
"title": "Blog table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_toc",
"type": "boolean",
"default": false
},
"post_dir": {
"title": "Blog posts directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir",
"type": "string",
"default": "\"{blog\\}/posts\""
},
"post_date_format": {
"title": "Format string for post dates",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_date_format",
"default": "long",
"oneOf": [
{
"enum": [
"full",
"long",
"medium",
"short"
]
},
{
"type": "string"
}
]
},
"post_url_date_format": {
"title": "Format string for post dates in URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_date_format",
"oneOf": [
{
"enum": [
"yyyy",
"yyyy/MM",
"yyyy/MM/dd"
]
},
{
"type": "string"
}
],
"default": "yyyy"
},
"post_url_format": {
"title": "Format string for post URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_format",
"oneOf": [
{
"enum": [
"\"{date}/{file}\"",
"\"{date}/{slug}\"",
"\"{file}\"",
"\"{slug}\""
]
},
{
"type": "string"
}
]
},
"post_url_max_categories": {
"title": "Number of categories in post URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_max_categories",
"type": "number",
"default": 1
},
"post_slugify": {
"title": "Post slugify function",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_slugify",
"default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
},
"post_slugify_separator": {
"title": "Post slugify separator",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_slugify_separator",
"type": "string",
"default": "\"-\""
},
"post_excerpt": {
"title": "Post excerpts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt",
"oneOf": [
{
"title": "Post excerpts are optional",
"enum": [
"optional"
]
},
{
"title": "Post excerpts are required, thus the build will fail",
"enum": [
"required"
]
}
],
"default": "optional"
},
"post_excerpt_max_authors": {
"title": "Number of authors to render in post excerpts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_authors",
"type": "number",
"default": 1
},
"post_excerpt_max_categories": {
"title": "Number of categories to render in post excerpts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_categories",
"type": "number",
"default": 5
},
"post_excerpt_separator": {
"title": "Post excerpt separator",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_separator",
"type": "string",
"default": "<!-- more -->"
},
"post_readtime": {
"title": "Post reading time computation",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_readtime",
"type": "boolean",
"default": true
},
"post_readtime_words_per_minute": {
"title": "Post reading time words per minute",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_readtime_words_per_minute",
"type": "number",
"default": 265
},
"archive": {
"title": "Archive",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive",
"type": "boolean",
"default": true
},
"archive_name": {
"title": "Archive name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_name",
"type": "string",
"default": "Archive"
},
"archive_date_format": {
"title": "Format string for archive dates",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_date_format",
"oneOf": [
{
"enum": [
"yyyy",
"MMMM yyyy"
]
},
{
"type": "string"
}
],
"default": "yyyy"
},
"archive_url_date_format": {
"title": "Format string for archive dates in URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_url_date_format",
"oneOf": [
{
"enum": [
"yyyy",
"yyyy/MM"
]
},
{
"type": "string"
}
],
"default": "yyyy"
},
"archive_url_format": {
"title": "Format string for archive URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_url_format",
"oneOf": [
{
"enum": [
"\"archive/{date}\""
]
},
{
"type": "string"
}
]
},
"archive_toc": {
"title": "Archive table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc",
"type": "boolean",
"default": false
},
"categories": {
"title": "Categories",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories",
"type": "boolean",
"default": true
},
"categories_name": {
"title": "Categories name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_name",
"type": "string",
"default": "Categories"
},
"categories_url_format": {
"title": "Format string for category URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_url_format",
"oneOf": [
{
"enum": [
"\"category/{slug}\"",
"\"{slug}\""
]
},
{
"type": "string"
}
]
},
"categories_slugify": {
"title": "Categories slugify function",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_slugify",
"default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
},
"categories_slugify_separator": {
"title": "Categories slugify separator",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_slugify_separator",
"type": "string",
"default": "\"-\""
},
"categories_allowed": {
"title": "Categories allowed",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"default": []
},
"categories_toc": {
"title": "Categories table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc",
"type": "boolean",
"default": false
},
"pagination": {
"title": "Pagination",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination",
"type": "boolean",
"default": true
},
"pagination_per_page": {
"title": "Posts per page",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_per_page",
"type": "number",
"default": 10
},
"pagination_url_format": {
"title": "Format string for pagination URLs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_url_format",
"oneOf": [
{
"enum": [
"\"page/{page}\"",
"\"{page}\""
]
},
{
"type": "string"
}
]
},
"pagination_template": {
"title": "Template string for pagination",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_template",
"oneOf": [
{
"enum": [
"~2~",
"$link_first $link_previous ~2~ $link_next $link_last",
"$link_previous $page $link_next"
]
},
{
"type": "string"
}
],
"default": "~2~"
},
"pagination_keep_content": {
"title": "Paginated indexes inherit content",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_keep_content",
"type": "boolean",
"default": false
},
"authors": {
"title": "Author info",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors",
"type": "boolean",
"default": true
},
"authors_file": {
"title": "Authors file",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file",
"type": "string",
"default": "\"{blog\\}/.authors.yml\""
},
"draft": {
"title": "Render posts marked as drafts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft",
"type": "boolean",
"default": false
},
"draft_on_serve": {
"title": "Render posts marked as drafts when previewing",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft_on_serve",
"type": "boolean",
"default": true
},
"draft_if_future_date": {
"title": "Automatically mark posts with future dates as drafts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft_if_future_date",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

29
schema/plugins/external/gen-files.json vendored Normal file
View File

@ -0,0 +1,29 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Generate pages during the build",
"oneOf": [
{
"markdownDescription": "https://github.com/oprypin/mkdocs-gen-files",
"enum": [
"git-authors"
]
},
{
"type": "object",
"properties": {
"gen-files": {
"additionalProperties": false,
"properties": {
"scripts": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": ["object", "null"]
}
}
}
]
}

41
schema/plugins/external/git-authors.json vendored Normal file
View File

@ -0,0 +1,41 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Add git authors to pages",
"oneOf": [
{
"markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/",
"enum": [
"git-authors"
]
},
{
"type": "object",
"properties": {
"git-authors": {
"markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/options.html",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/options.html#enabled",
"type": "boolean",
"default": true
},
"exclude": {
"title": "List of Markdown file patterns",
"markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/options.html#exclude",
"type": "array",
"items": {
"pattern": "(\\*|\\.md)$"
},
"uniqueItems": true,
"minItems": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

45
schema/plugins/external/git-committers.json vendored Normal file
View File

@ -0,0 +1,45 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Add git contributors to pages",
"oneOf": [
{
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2",
"enum": [
"git-committers"
]
},
{
"type": "object",
"properties": {
"git-committers": {
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.enabled",
"type": "boolean",
"default": true
},
"repository": {
"title": "Repository slug",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository",
"type": "string"
},
"branch": {
"title": "Repository branch",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.branch",
"type": "string",
"default": "master"
}
},
"additionalProperties": false,
"required": [
"repository"
]
}
},
"additionalProperties": false
}
]
}

42
schema/plugins/external/git-revision-date.json vendored Normal file
View File

@ -0,0 +1,42 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Add git revision date to pages",
"oneOf": [
{
"markdownDescription": "https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin",
"enum": [
"git-revision-date"
]
},
{
"type": "object",
"properties": {
"git-revision-date": {
"markdownDescription": "https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin",
"type": "object",
"properties": {
"enable_if_env": {
"title": "Enable plugin when environment variable is set",
"markdownDescription": "https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin#options",
"type": "string"
},
"modify_md": {
"title": "Enable plugin to be used in Markdown files",
"markdownDescription": "https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin#options",
"type": "boolean",
"default": true
},
"as_datetime": {
"title": "Output as Python datetime",
"markdownDescription": "https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin#options",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

37
schema/plugins/external/literate-nav.json vendored Normal file
View File

@ -0,0 +1,37 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Configure navigation in Markdown instead of YAML",
"oneOf": [
{
"markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav",
"enum": [
"literate-nav"
]
},
{
"type": "object",
"properties": {
"literate-nav": {
"markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav",
"type": "object",
"properties": {
"nav_file": {
"title": "The name of the file to read to determine the navigation for a particular directory under `docs_dir`",
"markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#nav_file",
"type": "string",
"default": "SUMMARY.md"
},
"implicit_index": {
"title": "If set and a directory has a file named `index.md` or `README.md`, but the literate nav for that directory that never includes it, it will be inserted as the first item of the nav",
"markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#implicit_index",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

72
schema/plugins/external/macros.json vendored Normal file
View File

@ -0,0 +1,72 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Use variables and macros in Markdown",
"oneOf": [
{
"markdownDescription": "https://github.com/fralau/mkdocs_macros_plugin",
"enum": [
"macros"
]
},
{
"type": "object",
"properties": {
"macros": {
"markdownDescription": "",
"type": "object",
"properties": {
"module_name": {
"title": "Name of the Python module containing macros, filters and variables",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin",
"type": "string",
"default": "main"
},
"modules": {
"title": "List of preinstalled Python modules, i.e. listed by `pip list`",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/#configuration-of-the-plugin",
"type": "array"
},
"include_dir": {
"title": "Directory for including external files",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#changing-the-directory-of-the-includes",
"type": "string"
},
"include_yaml": {
"title": "List of yaml files or `key: filename` pairs to be included",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#including-external-yaml-files",
"type": "array"
},
"j2_block_start_string": {
"title": "Non-standard Jinja2 marker for start of block",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros",
"type": "string"
},
"j2_block_end_string": {
"title": "Non-standard Jinja2 marker for end of block",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros",
"type": "string"
},
"j2_variable_start_string": {
"title": "Non-standard Jinja2 marker for start of variable",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros",
"type": "string"
},
"j2_variable_end_string": {
"title": "Non-standard Jinja2 marker for end of variable",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#solution-4-altering-the-syntax-of-jinja2-for-mkdocs-macros",
"type": "string"
},
"on_error_fail": {
"title": "Stop build/serve when macro error happens",
"markdownDescription": "https://mkdocs-macros-plugin.readthedocs.io/en/latest/advanced/#can-i-make-mkdocs-macros-build-process-to-fail-in-case-of-error-instead-of-displaying-the-error-on-the-page",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

76
schema/plugins/external/minify.json vendored Normal file
View File

@ -0,0 +1,76 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Minify HTML, JavaScript and CSS during the build",
"type": "object",
"properties": {
"minify": {
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin",
"type": "object",
"dependencies": {
"minify_js": [
"js_files"
],
"minify_css": [
"css_files"
]
},
"properties": {
"minify_html": {
"title": "Minify HTML files",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "boolean",
"default": true
},
"minify_js": {
"title": "Minify JavaScript files",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "boolean",
"default": false
},
"minify_css": {
"title": "Minify CSS files",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "boolean",
"default": false
},
"htmlmin_opts": {
"title": "Options for HTML minifier",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "object"
},
"cache_safe": {
"title": "Add hash to Javascript and CSS file names",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "boolean",
"default": false
},
"js_files": {
"title": "JavaScript files to minify",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "array",
"items": {
"title": "Path to JavaScript file",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"pattern": "\\.js$"
},
"uniqueItems": true,
"minItems": 1
},
"css_files": {
"title": "CSS files to minify",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"type": "array",
"items": {
"title": "Path to CSS file",
"markdownDescription": "https://github.com/byrnereese/mkdocs-minify-plugin#options",
"pattern": "\\.css$"
},
"uniqueItems": true,
"minItems": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}

51
schema/plugins/external/redirects.json vendored Normal file
View File

@ -0,0 +1,51 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Add redirects when moving pages to new locations",
"type": "object",
"properties": {
"redirects": {
"markdownDescription": "https://github.com/mkdocs/mkdocs-redirects",
"type": "object",
"properties": {
"redirect_maps": {
"title": "Mapping of Markdown files",
"markdownDescription": "https://github.com/mkdocs/mkdocs-redirects#using",
"type": "object",
"patternProperties": {
"\\.md$": {
"oneOf": [
{
"title": "Internal redirect",
"markdownDescription": "https://github.com/mkdocs/mkdocs-redirects#using",
"pattern": "\\.md(#\\S+)?$"
},
{
"title": "External redirect",
"markdownDescription": "https://github.com/mkdocs/mkdocs-redirects#using",
"pattern": "^https?:"
}
]
}
},
"defaultSnippets": [
{
"label": "Internal redirect",
"body": {
"${1:from}.md": "${2:to}.md"
}
},
{
"label": "External redirect",
"body": {
"${1:from}.md": "https://${2:to.url}"
}
}
],
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}

19
schema/plugins/external/section-index.json vendored Normal file
View File

@ -0,0 +1,19 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Add index section pages to navigation",
"oneOf": [
{
"markdownDescription": "https://github.com/oprypin/mkdocs-section-index",
"enum": [
"section-index"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"section-index": {}
}
}
]
}

29
schema/plugins/group.json Normal file
View File

@ -0,0 +1,29 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in group plugin",
"oneOf": [
{
"type": "object",
"properties": {
"group": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.enabled",
"type": "boolean",
"default": true
},
"plugins": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.plugins",
"$ref": "../plugins.json"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

49
schema/plugins/info.json Normal file
View File

@ -0,0 +1,49 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in info plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/",
"enum": [
"info"
]
},
{
"type": "object",
"properties": {
"info": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled",
"type": "boolean",
"default": true
},
"enabled_on_serve": {
"title": "Enable plugin when previewing",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled_on_serve",
"type": "boolean",
"default": false
},
"archive": {
"title": "Enable creation of archive",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive",
"type": "boolean",
"default": true
},
"archive_stop_on_violation": {
"title": "Stop creation of archive on violation",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive_stop_on_violation",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

37
schema/plugins/meta.json Normal file
View File

@ -0,0 +1,37 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in meta plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/",
"enum": [
"meta"
]
},
{
"type": "object",
"properties": {
"meta": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.enabled",
"type": "boolean",
"default": true
},
"meta_file": {
"title": "Meta file name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.meta_file",
"pattern": "\\.yml$",
"default": "\"**/.meta.yml\""
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

31
schema/plugins/offline.json Normal file
View File

@ -0,0 +1,31 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in offline plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/",
"enum": [
"offline"
]
},
{
"type": "object",
"properties": {
"offline": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/#config.enabled",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

120
schema/plugins/optimize.json Normal file
View File

@ -0,0 +1,120 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in optimize plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/",
"enum": [
"optimize"
]
},
{
"type": "object",
"properties": {
"optimize": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.enabled",
"type": "boolean",
"default": true
},
"concurrency": {
"title": "Concurrency (number of CPUs)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.concurrency",
"type": "number"
},
"cache": {
"title": "Enable caching",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache",
"type": "boolean",
"default": true
},
"cache_dir": {
"title": "Cache directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache_dir",
"type": "string",
"default": ".cache/plugins/optimize"
},
"optimize_png": {
"title": "Optimization of PNGs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png",
"type": "boolean",
"default": true
},
"optimize_png_speed": {
"title": "Speed/quality tradeoff [1,10]",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_speed",
"type": "number",
"default": 4
},
"optimize_png_strip": {
"title": "Strip unnecessary metadata from PNGs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_strip",
"type": "boolean",
"default": true
},
"optimize_jpg": {
"title": "Optimization of JPGs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg",
"type": "boolean",
"default": true
},
"optimize_jpg_quality": {
"title": "Speed/quality tradeoff for pngquant [0,10]",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_quality",
"type": "number",
"default": 60
},
"optimize_jpg_progressive": {
"title": "Progressive encoding (faster rendering)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_progressive",
"type": "boolean",
"default": true
},
"optimize_include": {
"title": "Files or folders to include",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include",
"type": "array",
"items": {
"title": "Files or folders matching this pattern will be included",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include",
"pattern": ".*"
},
"uniqueItems": true,
"minItems": 1
},
"optimize_exclude": {
"title": "Files or folders to exclude",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude",
"type": "array",
"items": {
"title": "Files or folders matching this pattern will be excluded",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude",
"pattern": ".*"
},
"uniqueItems": true,
"minItems": 1
},
"print_gain": {
"title": "Print optimization gain",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain",
"type": "boolean",
"default": true
},
"print_gain_summary": {
"title": "Print optimization gain summary",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

112
schema/plugins/privacy.json Normal file
View File

@ -0,0 +1,112 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in privacy plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/",
"enum": [
"privacy"
]
},
{
"type": "object",
"properties": {
"privacy": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.enabled",
"type": "boolean",
"default": true
},
"concurrency": {
"title": "Concurrency (number of CPUs)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.concurrency",
"type": "number"
},
"cache": {
"title": "Enable caching",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache",
"type": "boolean",
"default": true
},
"cache_dir": {
"title": "Cache directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache_dir",
"type": "string",
"default": ".cache/plugins/privacy"
},
"assets": {
"title": "Process external assets",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets",
"type": "boolean",
"default": true
},
"assets_fetch": {
"title": "Download external assets",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch",
"type": "boolean",
"default": true
},
"assets_fetch_dir": {
"title": "Download external assets to this directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch_dir",
"type": "string",
"default": "assets/external"
},
"assets_include": {
"title": "External assets to include",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include",
"type": "array",
"items": {
"title": "External assets matching this pattern will be downloaded",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include",
"pattern": ".*"
},
"uniqueItems": true,
"minItems": 1
},
"assets_exclude": {
"title": "External assets to exclude",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude",
"type": "array",
"items": {
"title": "External assets matching this pattern will not be downloaded",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude",
"pattern": ".*"
},
"uniqueItems": true,
"minItems": 1
},
"links": {
"title": "Process external links",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links",
"type": "boolean",
"default": true
},
"links_attr_map": {
"title": "Custom attributes to add to external links",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_attr_map",
"type": "object",
"patternProperties": {
"^[\\w_]+$": {
"type": "string"
}
}
},
"links_noopener": {
"title": "Behavior for external links that open in new windows",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_noopener",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

82
schema/plugins/projects.json Normal file
View File

@ -0,0 +1,82 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in projects plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/",
"enum": [
"projects"
]
},
{
"type": "object",
"properties": {
"projects": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.enabled",
"type": "boolean",
"default": true
},
"concurrency": {
"title": "Concurrency (number of CPUs)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.concurrency",
"type": "number"
},
"cache": {
"title": "Enable caching",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.cache",
"type": "boolean",
"default": true
},
"cache_dir": {
"title": "Cache directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.cache_dir",
"type": "string",
"default": ".cache/plugins/projects"
},
"projects": {
"title": "Enable projects",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects",
"type": "boolean",
"default": true
},
"projects_dir": {
"title": "Projects directory",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_dir",
"type": "string",
"default": "projects"
},
"projects_config_files": {
"title": "Projects configuration files",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_config_files",
"type": "string",
"default": "\"*/mkdocs.yml\""
},
"projects_config_transform": {
"title": "Projects configuration transform",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_config_transform",
"type": "string",
"defaultSnippets": [
{
"body": "!!python/name:${1:module}.${2:function}"
}
]
},
"hosting": {
"title": "Enable hoisting",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.hoisting",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

192
schema/plugins/search.json Normal file
View File

@ -0,0 +1,192 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in search plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/",
"enum": [
"search"
]
},
{
"type": "object",
"properties": {
"search": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/",
"type": "object",
"properties": {
"lang": {
"oneOf": [
{
"$ref": "#/definitions/lang"
},
{
"type": "array",
"items": {
"$ref": "#/definitions/lang"
},
"uniqueItems": true,
"minItems": 1
}
],
"default": "en"
},
"separator": {
"title": "Separator for indexing and query tokenization",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.separator",
"type": "string"
},
"pipeline": {
"title": "Text processing pipeline for indexing",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.pipeline",
"type": "array",
"items": {
"enum": [
"stemmer",
"stopWordFilter",
"trimmer"
]
},
"uniqueItems": true
},
"jieba_dict": {
"title": "Jieba dictionary replacement",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict",
"type": "string"
},
"jieba_dict_user": {
"title": "Jieba dictionary augmentation",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict_user",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
],
"definitions": {
"lang": {
"title": "Site search language",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.lang",
"oneOf": [
{
"title": "Site search language: Arabic",
"enum": [
"ar"
]
},
{
"title": "Site search language: Danish",
"enum": [
"da"
]
},
{
"title": "Site search language: German",
"enum": [
"de"
]
},
{
"title": "Site search language: Dutch",
"enum": [
"du"
]
},
{
"title": "Site search language: English",
"enum": [
"en"
]
},
{
"title": "Site search language: Spanish",
"enum": [
"es"
]
},
{
"title": "Site search language: Finnish",
"enum": [
"fi"
]
},
{
"title": "Site search language: French",
"enum": [
"fr"
]
},
{
"title": "Site search language: Hungarian",
"enum": [
"hu"
]
},
{
"title": "Site search language: Italian",
"enum": [
"it"
]
},
{
"title": "Site search language: Japanese",
"enum": [
"ja"
]
},
{
"title": "Site search language: Norwegian",
"enum": [
"no"
]
},
{
"title": "Site search language: Portuguese",
"enum": [
"pt"
]
},
{
"title": "Site search language: Romanian",
"enum": [
"ro"
]
},
{
"title": "Site search language: Russian",
"enum": [
"ru"
]
},
{
"title": "Site search language: Swedish",
"enum": [
"sv"
]
},
{
"title": "Site search language: Thai",
"enum": [
"th"
]
},
{
"title": "Site search language: Turkish",
"enum": [
"tr"
]
},
{
"title": "Site search language: Vietnamese",
"enum": [
"vi"
]
}
]
}
}
}

143
schema/plugins/social.json Normal file
View File

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

93
schema/plugins/tags.json Normal file
View File

@ -0,0 +1,93 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in tags plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/",
"enum": [
"tags"
]
},
{
"type": "object",
"properties": {
"tags": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.enabled",
"type": "boolean",
"default": true
},
"tags_file": {
"title": "Markdown file to render tags index",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_file",
"pattern": "\\.md$",
"default": "tags.md"
},
"tags_extra_files": {
"title": "Markdown files to render additional tags indexes",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_extra_files",
"type": "object",
"patternProperties": {
"\\.md$": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
"additionalProperties": false
},
"tags_slugify": {
"title": "Tags slugify function",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify",
"default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}"
},
"tags_slugify_separator": {
"title": "Tags slugify separator",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify_separator",
"type": "string",
"default": "\"-\""
},
"tags_compare": {
"title": "Sort tags by this function",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_compare",
"default": "!!python/name:material.plugins.tags.casefold"
},
"tags_compare_reverse": {
"title": "Soft tags in reverse",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_compare_reverse",
"default": false
},
"tags_pages_compare": {
"title": "Sort tags pages by this function",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_pages_compare",
"default": "!!python/name:material.plugins.tags.page_title"
},
"tags_pages_compare_reverse": {
"title": "Soft tags pages in reverse",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_pages_compare_reverse",
"default": false
},
"tags_allowed": {
"title": "Tags allowed",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_allowed",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"default": []
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

31
schema/plugins/typeset.json Normal file
View File

@ -0,0 +1,31 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Built-in typeset plugin",
"oneOf": [
{
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/",
"enum": [
"typeset"
]
},
{
"type": "object",
"properties": {
"typeset": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/",
"type": "object",
"properties": {
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/#config.enabled",
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
}

990
schema/theme.json Normal file
View File

@ -0,0 +1,990 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Theme configuration",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/",
"type": "object",
"properties": {
"name": {
"title": "Theme name",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#name",
"oneOf": [
{
"enum": [
"material"
]
},
{
"type": "null"
}
],
"default": "material"
},
"custom_dir": {
"title": "Directory with theme overrides",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#setup-and-theme-structure",
"type": "string",
"defaultSnippets": [
{
"body": "${1:overrides}"
}
]
},
"static_templates": {
"title": "Static templates to render",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#static_templates",
"type": "array",
"items": {
"title": "Path to HTML file",
"markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#static_templates",
"pattern": "\\.html$"
},
"uniqueItems": true,
"minItems": 1
},
"language": {
"title": "Site language",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/",
"oneOf": [
{
"title": "Site language: Custom",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#custom-translations",
"enum": [
"custom"
]
},
{
"title": "Site language: Afrikaans",
"enum": [
"af"
]
},
{
"title": "Site language: Arabic",
"enum": [
"ar"
]
},
{
"title": "Site language: Bulgarian",
"enum": [
"bg"
]
},
{
"title": "Site language: Bengali (Bangla)",
"enum": [
"bn"
]
},
{
"title": "Site language: Catalan",
"enum": [
"ca"
]
},
{
"title": "Site language: Czech",
"enum": [
"cs"
]
},
{
"title": "Site language: Danish",
"enum": [
"da"
]
},
{
"title": "Site language: German",
"enum": [
"de"
]
},
{
"title": "Site language: Greek",
"enum": [
"el"
]
},
{
"title": "Site language: English",
"enum": [
"en"
]
},
{
"title": "Site language: Esperanto",
"enum": [
"eo"
]
},
{
"title": "Site language: Spanish",
"enum": [
"es"
]
},
{
"title": "Site language: Estonian",
"enum": [
"et"
]
},
{
"title": "Site language: Persian (Farsi)",
"enum": [
"fa"
]
},
{
"title": "Site language: Finnish",
"enum": [
"fi"
]
},
{
"title": "Site language: French",
"enum": [
"fr"
]
},
{
"title": "Site language: Galician",
"enum": [
"gl"
]
},
{
"title": "Site language: Hebrew",
"enum": [
"he"
]
},
{
"title": "Site language: Hindi",
"enum": [
"hi"
]
},
{
"title": "Site language: Croatian",
"enum": [
"hr"
]
},
{
"title": "Site language: Hungarian",
"enum": [
"hu"
]
},
{
"title": "Site language: Armenian",
"enum": [
"hy"
]
},
{
"title": "Site language: Indonesian",
"enum": [
"id"
]
},
{
"title": "Site language: Icelandic",
"enum": [
"is"
]
},
{
"title": "Site language: Italian",
"enum": [
"it"
]
},
{
"title": "Site language: Japanese",
"enum": [
"ja"
]
},
{
"title": "Site language: Georgian",
"enum": [
"ka"
]
},
{
"title": "Site language: Kannada",
"enum": [
"kn"
]
},
{
"title": "Site language: Korean",
"enum": [
"ko"
]
},
{
"title": "Site language: Lithuanian",
"enum": [
"lt"
]
},
{
"title": "Site language: Latvian",
"enum": [
"lv"
]
},
{
"title": "Site language: Macedonian",
"enum": [
"mk"
]
},
{
"title": "Site language: Mongolian",
"enum": [
"mn"
]
},
{
"title": "Site language: Bahasa Malaysia",
"enum": [
"ms"
]
},
{
"title": "Site language: Burmese",
"enum": [
"my"
]
},
{
"title": "Site language: Dutch",
"enum": [
"nl"
]
},
{
"title": "Site language: Norwegian (Bokmål)",
"enum": [
"nb"
]
},
{
"title": "Site language: Norwegian (Nynorsk)",
"enum": [
"nn"
]
},
{
"title": "Site language: Polish",
"enum": [
"pl"
]
},
{
"title": "Site language: Portuguese",
"enum": [
"pt"
]
},
{
"title": "Site language: Portuguese (Brasilian)",
"enum": [
"pt-BR"
]
},
{
"title": "Site language: Romanian",
"enum": [
"ro"
]
},
{
"title": "Site language: Russian",
"enum": [
"ru"
]
},
{
"title": "Site language: Sanskrit",
"enum": [
"sa"
]
},
{
"title": "Site language: Serbo-Croatian",
"enum": [
"sh"
]
},
{
"title": "Site language: Sinhalese",
"enum": [
"si"
]
},
{
"title": "Site language: Slovak",
"enum": [
"sk"
]
},
{
"title": "Site language: Slovenian",
"enum": [
"sl"
]
},
{
"title": "Site language: Serbian",
"enum": [
"sr"
]
},
{
"title": "Site language: Swedish",
"enum": [
"sv"
]
},
{
"title": "Site language: Telugu",
"enum": [
"te"
]
},
{
"title": "Site language: Thai",
"enum": [
"th"
]
},
{
"title": "Site language: Tagalog",
"enum": [
"tl"
]
},
{
"title": "Site language: Turkish",
"enum": [
"tr"
]
},
{
"title": "Site language: Ukrainian",
"enum": [
"uk"
]
},
{
"title": "Site language: Urdu",
"enum": [
"ur"
]
},
{
"title": "Site language: Uzbek",
"enum": [
"uz"
]
},
{
"title": "Site language: Vietnamese",
"enum": [
"vi"
]
},
{
"title": "Site language: Chinese (Simplified)",
"enum": [
"zh"
]
},
{
"title": "Site language: Chinese (Traditional)",
"enum": [
"zh-Hant"
]
},
{
"title": "Site language: Chinese (Taiwanese)",
"enum": [
"zh-TW"
]
}
],
"default": "en"
},
"direction": {
"title": "Directionality",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#directionality",
"enum": [
"ltr",
"rtl"
]
},
"favicon": {
"title": "Favicon",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon",
"pattern": "\\.(ico|png|svg|jpe?g)$",
"defaultSnippets": [
{
"body": "${1:path/to/file}.png"
}
]
},
"logo": {
"title": "Logo",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo",
"pattern": "\\.(png|svg|jpe?g)$",
"defaultSnippets": [
{
"body": "${1:path/to/file}.png"
}
]
},
"icon": {
"title": "Icons",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/",
"type": "object",
"properties": {
"edit": {
"$ref": "#/definitions/icon"
},
"view": {
"$ref": "#/definitions/icon"
},
"logo": {
"$ref": "#/definitions/icon"
},
"repo": {
"$ref": "#/definitions/icon"
},
"admonition": {
"title": "Admonition icon",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons",
"type": "object",
"properties": {
"note": {
"$ref": "#/definitions/icon"
},
"abstract": {
"$ref": "#/definitions/icon"
},
"info": {
"$ref": "#/definitions/icon"
},
"tip": {
"$ref": "#/definitions/icon"
},
"success": {
"$ref": "#/definitions/icon"
},
"question": {
"$ref": "#/definitions/icon"
},
"warning": {
"$ref": "#/definitions/icon"
},
"failure": {
"$ref": "#/definitions/icon"
},
"danger": {
"$ref": "#/definitions/icon"
},
"bug": {
"$ref": "#/definitions/icon"
},
"example": {
"$ref": "#/definitions/icon"
},
"quote": {
"$ref": "#/definitions/icon"
}
},
"additionalProperties": false,
"defaultSnippets": [
{
"label": "note",
"body": "note: ${1:material/pencil-circle}"
},
{
"label": "abstract",
"body": "abstract: ${1:material/clipboard-text}"
},
{
"label": "info",
"body": "info: ${1:material/information}"
},
{
"label": "tip",
"body": "tip: ${1:material/fire}"
},
{
"label": "success",
"body": "success: ${1:material/check}"
},
{
"label": "question",
"body": "question: ${1:material/help-circle}"
},
{
"label": "warning",
"body": "warning: ${1:material/alert}"
},
{
"label": "failure",
"body": "failure: ${1:material/close}"
},
{
"label": "danger",
"body": "danger: ${1:material/lightning-bolt-circle}"
},
{
"label": "bug",
"body": "bug: ${1:material/shield-bug}"
},
{
"label": "example",
"body": "example: ${1:material/test-tube}"
},
{
"label": "quote",
"body": "quote: ${1:material/format-quote-close}"
}
]
},
"tag": {
"title": "Tag icon",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers",
"type": "object",
"patternProperties": {
"^[\\w-]+$": {
"$ref": "#/definitions/icon"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"defaultSnippets": [
{
"label": "edit",
"body": "edit: ${1:material/pencil}"
},
{
"label": "logo",
"body": "logo: ${1:material/library}"
},
{
"label": "repo",
"body": "repo: ${1:fontawesome/brands/git-alt}"
}
]
},
"features": {
"title": "Feature flags",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/",
"type": "array",
"items": {
"oneOf": [
{
"title": "Mark as read",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#mark-as-read",
"enum": [
"announce.dismiss"
]
},
{
"title": "Edit this page",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions",
"enum": [
"content.action.edit"
]
},
{
"title": "View source of this page",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions",
"enum": [
"content.action.view"
]
},
{
"title": "Code annotations",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations",
"enum": [
"content.code.annotate"
]
},
{
"title": "Code copy button",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button",
"enum": [
"content.code.copy"
]
},
{
"title": "Code selection button",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button",
"enum": [
"content.code.select"
]
},
{
"title": "Linked content tabs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs",
"enum": [
"content.tabs.link"
]
},
{
"title": "Improved tooltips",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips",
"enum": [
"content.tooltips"
]
},
{
"title": "Header hides automatically when scrolling",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#automatic-hiding",
"enum": [
"header.autohide"
]
},
{
"title": "Navigation expansion",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion",
"enum": [
"navigation.expand"
]
},
{
"title": "Navigation footer",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-footer",
"enum": [
"navigation.footer"
]
},
{
"title": "Section index pages",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages",
"enum": [
"navigation.indexes"
]
},
{
"title": "Instant loading",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading",
"enum": [
"navigation.instant"
]
},
{
"title": "Navigation path (Breadcrumbs)",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path",
"enum": [
"navigation.path"
]
},
{
"title": "Navigation pruning",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-pruning",
"enum": [
"navigation.prune"
]
},
{
"title": "Navigation sections",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections",
"enum": [
"navigation.sections"
]
},
{
"title": "Navigation tabs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs",
"enum": [
"navigation.tabs"
]
},
{
"title": "Sticky navigation tabs",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#sticky-navigation-tabs",
"enum": [
"navigation.tabs.sticky"
]
},
{
"title": "Back-to-top button",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button",
"enum": [
"navigation.top"
]
},
{
"title": "Anchor tracking",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-tracking",
"enum": [
"navigation.tracking"
]
},
{
"title": "Search higlighting",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting",
"enum": [
"search.highlight"
]
},
{
"title": "Search sharing",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing",
"enum": [
"search.share"
]
},
{
"title": "Search suggestions",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions",
"enum": [
"search.suggest"
]
},
{
"title": "Integrated table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following",
"enum": [
"toc.follow"
]
},
{
"title": "Integrated table of contents",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration",
"enum": [
"toc.integrate"
]
}
]
},
"uniqueItems": true,
"minItems": 1
},
"palette": {
"oneOf": [
{
"title": "Color palette",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/",
"type": "object",
"properties": {
"scheme": {
"$ref": "#/definitions/scheme"
},
"primary": {
"$ref": "#/definitions/primary"
},
"accent": {
"$ref": "#/definitions/accent"
}
},
"additionalProperties": false
},
{
"title": "Color palette",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/",
"type": "array",
"items": {
"type": "object",
"properties": {
"scheme": {
"$ref": "#/definitions/scheme"
},
"primary": {
"$ref": "#/definitions/primary"
},
"accent": {
"$ref": "#/definitions/accent"
},
"media": {
"oneOf": [
{
"title": "System preference",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#system-preference",
"type": "string",
"enum": [
"\"(prefers-color-scheme: light)\"",
"\"(prefers-color-scheme: dark)\""
]
},
{
"type": "string"
}
],
"defaultSnippets": [
{
"label": "\"(prefers-color-scheme: light)\"",
"body": "\"(prefers-color-scheme: ${1:light})\""
}
]
},
"toggle": {
"title": "Color palette toggle",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle",
"properties": {
"icon": {
"$ref": "#/definitions/icon"
},
"name": {
"title": "Color palette toggle name",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#toggle-name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"icon",
"name"
]
}
},
"additionalProperties": false,
"required": [
"toggle"
]
},
"uniqueItems": true,
"minItems": 1
}
],
"default": {
"scheme": "default",
"primary": "indigo",
"accent": "indigo"
}
},
"font": {
"oneOf": [
{
"title": "Google Fonts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/",
"properties": {
"text": {
"$ref": "assets/fonts.json"
},
"code": {
"$ref": "assets/fonts.json"
}
},
"additionalProperties": false
},
{
"title": "Disable Google Fonts",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading",
"enum": [
false
]
}
],
"defaultSnippets": [
{
"body": {
"text": "${1:Roboto}",
"code": "${2:Roboto Mono}"
}
}
]
}
},
"additionalProperties": false,
"required": [
"name"
],
"definitions": {
"scheme": {
"title": "Color scheme",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme",
"anyOf": [
{
"enum": [
"default",
"slate"
]
},
{
"type": "string"
}
]
},
"primary": {
"title": "Primary color",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color",
"enum": [
"red",
"pink",
"purple",
"deep purple",
"indigo",
"blue",
"light blue",
"cyan",
"teal",
"green",
"light green",
"lime",
"yellow",
"amber",
"orange",
"deep orange",
"brown",
"grey",
"blue grey",
"black",
"white",
"custom"
]
},
"accent": {
"title": "Accent color",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#accent-color",
"enum": [
"red",
"pink",
"purple",
"deep purple",
"indigo",
"blue",
"light blue",
"cyan",
"teal",
"green",
"light green",
"lime",
"yellow",
"amber",
"orange",
"deep orange",
"brown",
"grey",
"blue grey",
"black",
"white",
"custom"
]
},
"icon": {
"anyOf": [
{
"$ref": "assets/icons.json"
},
{
"title": "Unknown icon",
"type": "string"
}
]
}
}
}