Initial Commit
Bringing Documentation into Gitea
This commit is contained in:
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": {}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user