Skip to content

Commit

Permalink
chore: format README
Browse files Browse the repository at this point in the history
  • Loading branch information
harrydowning committed Jul 6, 2024
1 parent a32c9a3 commit befcc0b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

## Features

Syntax highlighting within YAML block-scalars for [40+ built-in languages](#built-in-languages- 'Built-In Languages') and the ability to add highlighting for any other language with the [yaml-embedded-languages.include](#extension-settings- 'Extension Settings') configuration setting.
Syntax highlighting within YAML block-scalars for [40+ built-in languages](#built-in-languages- "Built-In Languages") and the ability to add highlighting for any other language with the [yaml-embedded-languages.include](#extension-settings- "Extension Settings") configuration setting.

![Example yaml file showing syntax highlighting](https://raw.githubusercontent.com/harrydowning/yaml-embedded-languages/master/images/example.png)

### Built-In Languages

The following list shows all valid identifiers for the built-in languages:

- c
- clojure
- coffee
Expand Down Expand Up @@ -58,15 +60,14 @@ None

## Extension Settings

| Name | Description |
| ---- | ----------- |
| Name | Description |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `yaml-embedded-languages.include` | Allows the user to include their own languages by providing an object where each key defines the language identifier with regex and the corresponding value specifies the language TextMate `scopeName`. This can be used to add any other language, which could be from another extension. This also allows the user to override any language identifiers currently used for the built-in languages. |

## Known Issues

See [Issues](https://github.com/harrydowning/yaml-embedded-languages/issues)


## Contribution Notes

See [CONTRIBUTING](CONTRIBUTING.md)
Expand Down

0 comments on commit befcc0b

Please sign in to comment.