Initial Commit
Bringing Documentation into Gitea
This commit is contained in:
365
schema/plugins/blog.json
Normal file
365
schema/plugins/blog.json
Normal 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
29
schema/plugins/external/gen-files.json
vendored
Normal 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
41
schema/plugins/external/git-authors.json
vendored
Normal 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
45
schema/plugins/external/git-committers.json
vendored
Normal 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
42
schema/plugins/external/git-revision-date.json
vendored
Normal 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
37
schema/plugins/external/literate-nav.json
vendored
Normal 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
72
schema/plugins/external/macros.json
vendored
Normal 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
76
schema/plugins/external/minify.json
vendored
Normal 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
51
schema/plugins/external/redirects.json
vendored
Normal 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
19
schema/plugins/external/section-index.json
vendored
Normal 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
29
schema/plugins/group.json
Normal 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
49
schema/plugins/info.json
Normal 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
37
schema/plugins/meta.json
Normal 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
31
schema/plugins/offline.json
Normal 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
120
schema/plugins/optimize.json
Normal 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
112
schema/plugins/privacy.json
Normal 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
82
schema/plugins/projects.json
Normal 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
192
schema/plugins/search.json
Normal 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
143
schema/plugins/social.json
Normal 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
93
schema/plugins/tags.json
Normal 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
31
schema/plugins/typeset.json
Normal 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
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user