OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated JSON Schema (#4905)

Browse Source 
Related: https://github.com/ansible/devtools/issues/86
This commit is contained in:
Sorin Sbarnea 2023-01-28 13:35:24 +00:00 committed by GitHub
parent e9274f61ea
commit 7132103e24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 118 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/schema.json
View File

@ -153,6 +153,13 @@
},
"nav": {
"$ref": "schema/nav.json"
},
"watch": {
"items": {
"title": "Path to watch for changes",
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false

8
docs/schema/extensions/markdown.json
View File

@ -27,6 +27,14 @@
"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",

52
docs/schema/extensions/pymdownx.json
View File

@ -324,18 +324,66 @@
"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"
"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"
"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,

6
docs/schema/plugins.json
View File

@ -51,6 +51,9 @@
"external": {
"description": "External plugins, schema provided by us",
"oneOf": [
{
"$ref": "plugins/external/gen-files.json"
},
{
"$ref": "plugins/external/git-authors.json"
},
@ -71,6 +74,9 @@
},
{
"$ref": "plugins/external/redirects.json"
},
{
"$ref": "plugins/external/section-index.json"
}
]
},

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

@ -0,0 +1,28 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "MkDocs plugin to programmatically generate documentation 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"]
}
}
}]
}

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

@ -0,0 +1,19 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "MkDocs plugin to allow clickable sections that lead to an index page",
"oneOf": [
{
"markdownDescription": "https://github.com/oprypin/mkdocs-section-index",
"enum": [
"section-index"
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"section-index": {
}
}
}]
}