Skip to content

Commit

Permalink
README: Fix syntax highlighting (#945)
Browse files Browse the repository at this point in the history
All JSON is YAML, but no the other way around.

Co-authored-by: Muthurajan Sivasubramanian <93245779+msivasubramaniaan@users.noreply.github.com>
  • Loading branch information
pierreprinetti and msivasubramaniaan committed Jan 5, 2024
1 parent d354c58 commit 5458ed3
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The following settings are supported:

In order to use the custom tags in your YAML file you need to first specify the custom tags in the setting of your code editor. For example, we can have the following custom tags:

```YAML
```yaml
"yaml.customTags": [
"!Scalar-example scalar",
"!Seq-example sequence",
Expand All @@ -70,7 +70,7 @@ The !Scalar-example would map to a scalar custom tag, the !Seq-example would map

We can then use the newly defined custom tags inside our YAML file:

```YAML
```yaml
some_key: !Scalar-example some_value
some_sequence: !Seq-example
- some_seq_key_1: some_seq_value_1
Expand All @@ -93,7 +93,7 @@ myProject

you can do

```
```yaml
yaml.schemas: {
"https://json.schemastore.org/composer": "/myYamlFile.yaml"
}
Expand All @@ -109,7 +109,7 @@ and that will associate the composer schema with myYamlFile.yaml.

When associating a schema it should follow the format below

```json
```yaml
yaml.schemas: {
"url": "globPattern",
"Kubernetes": "globPattern"
Expand All @@ -118,23 +118,23 @@ yaml.schemas: {

e.g.

```json
```yaml
yaml.schemas: {
"https://json.schemastore.org/composer": "/*"
}
```

e.g.

```json
```yaml
yaml.schemas: {
"kubernetes": "/myYamlFile.yaml"
}
```

e.g.

```json
```yaml
yaml.schemas: {
"https://json.schemastore.org/composer": "/*",
"kubernetes": "/myYamlFile.yaml"
Expand All @@ -143,37 +143,37 @@ yaml.schemas: {

On Windows with full path:

```json
```yaml
yaml.schemas: {
"C:\\Users\\user\\Documents\\custom_schema.json": "someFilePattern.yaml",
}
```

On Mac/Linux with full path:

```json
```yaml
yaml.schemas: {
"/home/user/custom_schema.json": "someFilePattern.yaml",
}
```

Since `0.11.0` YAML Schemas can be used for validation:

```json
```yaml
"/home/user/custom_schema.yaml": "someFilePattern.yaml"
```

A schema can be associated with multiple globs using a json array, e.g.

```json
```yaml
yaml.schemas: {
"kubernetes": ["filePattern1.yaml", "filePattern2.yaml"]
}
```

e.g.

```json
```yaml
"yaml.schemas": {
"http://json.schemastore.org/composer": ["/*"],
"file:///home/johnd/some-schema.json": ["some.yaml"],
Expand All @@ -184,15 +184,15 @@ e.g.

e.g.

```json
```yaml
"yaml.schemas": {
"kubernetes": ["/myYamlFile.yaml"]
}
```

e.g.

```json
```yaml
"yaml.schemas": {
"http://json.schemastore.org/composer": ["/*"],
"kubernetes": ["/myYamlFile.yaml"]
Expand All @@ -205,7 +205,7 @@ You can also use relative paths when working with multi root workspaces.

Suppose you have a multi root workspace that is laid out like:

```
```yaml
My_first_project:
test.yaml
my_schema.json
Expand All @@ -216,7 +216,7 @@ My_second_project:

You must then associate schemas relative to the root of the multi root workspace project.

```
```yaml
yaml.schemas: {
"My_first_project/my_schema.json": "test.yaml",
"My_second_project/my_schema2.json": "test2.yaml"
Expand All @@ -229,7 +229,7 @@ yaml.schemas: {

Suppose a file is meant to be a component of an existing schema (like a `job.yaml` file in a circleci orb), but there isn't a standalone schema that you can reference. If there is a nested schema definition for this subcomponent, you can reference it using a url fragment, e.g.:

```
```yaml
yaml.schemas: {
"https://json.schemastore.org/circleciconfig#/definitions/jobs/additionalProperties": "/src/jobs/*.yaml",
}
Expand Down Expand Up @@ -275,7 +275,7 @@ The image is located at `quay.io/redhat-developer/yaml-language-server`

To run the image you can use:

```
```sh
docker run -it quay.io/redhat-developer/yaml-language-server:latest
```

Expand Down

0 comments on commit 5458ed3

Please sign in to comment.