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

Added git-revision-date plugins to JSON schema

Browse Source
This commit is contained in:
squidfunk 2022-01-30 18:17:51 +01:00
parent 86518f1ae5
commit dd21aabd68
3 changed files with 128 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/schema/plugins.json
View File

@ -5,6 +5,12 @@
"type": "array",
"items": {
"oneOf": [
{
"$ref": "plugins/git-revision-date.json"
},
{
"$ref": "plugins/git-revision-date-localized.json"
},
{
"$ref": "plugins/minify.json"
},

80
docs/schema/plugins/git-revision-date-localized.json Normal file
View File

@ -0,0 +1,80 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Git revision date plugin with localization support",
"oneOf": [
{
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/",
"enum": [
"git-revision-date-localized"
]
},
{
"type": "object",
"properties": {
"git-revision-date-localized": {
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/",
"type": "object",
"properties": {
"type": {
"title": "Date display format",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#type",
"type": "string",
"enum": [
"date",
"datetime",
"iso_date",
"iso_datetime",
"timeago"
],
"default": "date"
},
"timezone": {
"title": "Date timezone",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#timezone",
"type": "string"
},
"locale": {
"title": "Date locale",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#locale",
"type": "string"
},
"fallback_to_build_date": {
"title": "Use build date when git is not available",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#fallback_to_build_date",
"type": "boolean",
"default": false
},
"enable_creation_date": {
"title": "Enable support for creation date",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enable_creation_date",
"type": "boolean",
"default": false
},
"exclude": {
"title": "List of Markdown file patterns",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#exclude",
"type": "array",
"items": {
"pattern": "(\\*|\\.md)$"
}
},
"enabled": {
"title": "Enable plugin",
"markdownDescription": "https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled",
"type": "boolean",
"default": true
}
},
"additionalProperties": false,
"defaultSnippets": [
{
"label": "type",
"body": "type: date"
}
]
}
},
"additionalProperties": false
}
]
}

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

@ -0,0 +1,42 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Git revision date plugin",
"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
}
]
}