You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/config-file.adoc
+9-4Lines changed: 9 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,15 @@ More information about the generators can be found in the xref:generators.adoc[G
18
18
19
19
== YAML Schema
20
20
21
-
To get linting and autocompletion in the config file, a schema for the config can be specified.
22
-
In JetBrains IDEs, `# $schema: <url>` can be used to bind a schema to a file.
23
-
In editors with plugins based on the https://github.com/redhat-developer/yaml-language-server[YAML language server], `# yaml-language-server: $schema=<url>` can be used.
24
-
The schema for `mrdocs.yml` is provided xref:attachment$mrdocs.schema.json[here].
21
+
To get linting and autocompletion in the config file, a schema for the config can be specified. The schema for `mrdocs.yml` is provided xref:attachment$mrdocs.schema.json[here].
22
+
23
+
The schema for `mrdocs.yml` is available from https://www.schemastore.org/json/, which is automatically detected and used by most editors.
24
+
25
+
To manually set the schema in an editor, the following can be used:
26
+
27
+
* In JetBrains IDEs, `# $schema: <url>` can be used to bind a schema to a file.
28
+
* In editors with plugins based on the https://github.com/redhat-developer/yaml-language-server[YAML language server], `# yaml-language-server: $schema=<url>` can be used.
29
+
25
30
The following shows an example of a file specifying an inline-schema that's compatible with JetBrains IDEs and editors using the YAML language server.
0 commit comments