Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 15:40:15 +01:00
Code Issues Releases Wiki Activity

Added default variants for plugins to schema

Browse Source
This commit is contained in:
squidfunk 2022-12-17 23:00:06 +01:00
parent 6d99740536
commit 65501ffc93
2 changed files with 89 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/schema/plugins/external/literate-nav.json vendored
View File

@ -1,27 +1,37 @@
{ {
"$schema": "http://json-schema.org/draft-07/schema", "$schema": "http://json-schema.org/draft-07/schema",
"title": "Literate nav plugin", "title": "Literate navigation plugin",
"type": "object", "oneOf": [
"properties": { {
"literate-nav": {
"markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav", "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav",
"enum": [
"literate-nav"
]
},
{
"type": "object", "type": "object",
"properties": { "properties": {
"nav_file": { "literate-nav": {
"title": "The name of the file to read to determine the navigation for a particular directory under `docs_dir`", "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav",
"markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#nav_file", "type": "object",
"type": "string", "properties": {
"default": "SUMMARY.md" "nav_file": {
}, "title": "The name of the file to read to determine the navigation for a particular directory under `docs_dir`",
"implicit_index": { "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#nav_file",
"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", "type": "string",
"markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#implicit_index", "default": "SUMMARY.md"
"type": "boolean", },
"default": false "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 "additionalProperties": false
} }
}, ]
"additionalProperties": false
} }

114
docs/schema/plugins/external/macros.json vendored
View File

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