Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harrydowning/vscode-yaml-embedded-languages
A VS Code syntax extension for embedded language highlighting in YAML
https://github.com/harrydowning/vscode-yaml-embedded-languages
javascript syntax-highlighting vscode vscode-extension yaml
Last synced: about 1 month ago
JSON representation
A VS Code syntax extension for embedded language highlighting in YAML
- Host: GitHub
- URL: https://github.com/harrydowning/vscode-yaml-embedded-languages
- Owner: harrydowning
- License: mit
- Created: 2023-02-01T11:12:48.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T19:56:58.000Z (2 months ago)
- Last Synced: 2024-10-17T06:31:06.423Z (2 months ago)
- Topics: javascript, syntax-highlighting, vscode, vscode-extension, yaml
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=harrydowning.yaml-embedded-languages
- Size: 236 KB
- Stars: 30
- Watchers: 3
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# YAML Embedded Languages
## Features
Syntax highlighting within YAML block-scalars for [50+ 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.
### Usage
To highlight a single block, place a comment with the language identifier next to the block identifier.
```yaml
example: | #
highlighted
```
To highlight all blocks from a point onwards, place a comment with the extension name followed by the language identifier.
```yaml
# yaml-embedded-languages:
example: |
highlighted
```
To stop highlighting blocks place a comment with the extension name.
```yaml
# yaml-embedded-languages
example: |
not highlighted
```
### Built-In Languages
The following list shows all valid identifiers for the built-in languages:
| Language | Identifier |
| ---------------- | --------------------- |
| bat | `bat` |
| bibtex | `bibtex` |
| c | `c` |
| clojure | `clojure` |
| coffeescript | `coffee` |
| cpp | `cpp`, `c++` |
| csharp | `csharp`, `c#` |
| css | `css` |
| cuda-cpp | `cuda` |
| dart | `dart` |
| diff | `diff` |
| dockercompose | `dockercompose` |
| dockerfile | `dockerfile` |
| fsharp | `fsharp`, `f#` |
| go | `go` |
| groovy | `groovy` |
| handlebars | `handlebars` |
| hlsl | `hlsl` |
| html | `html` |
| ini | `ini` |
| jade | `jade` |
| java | `java` |
| javascript | `js`, `javascript` |
| javascriptreact | `jsx` |
| json | `json` |
| jsonc | `jsonc` |
| jsonl | `jsonl` |
| julia | `julia` |
| latex | `latex` |
| less | `less` |
| log | `log` |
| lua | `lua` |
| makefile | `make`, `makefile` |
| markdown | `markdown` |
| markdown-math | `math` |
| objective-c | `objc` |
| objective-cpp | `objcpp` |
| perl | `perl` |
| php | `php` |
| pip-requirements | `pip`, `requirements` |
| powerfx\* | `powerfx` |
| powershell | `powershell` |
| properties | `properties` |
| python | `py`, `python` |
| r | `r` |
| raku | `raku` |
| razor | `razor` |
| regex\* | `regex` |
| restructuredtext | `rst` |
| ruby | `ruby` |
| rust | `rust` |
| scss | `scss` |
| shaderlab | `shaderlab` |
| shellscript | `shell` |
| sql | `sql` |
| swift | `swift` |
| tex | `tex` |
| typescript | `ts`, `typescript` |
| typescriptreact | `tsx` |
| vb | `vb` |
| xml | `xml` |
| xsl | `xsl` |
| yaml | `yaml` |
\*_Not a valid VS Code language_
## Requirements
None
## Extension Settings
| Name | Description |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `yaml-embedded-languages.include` | An object where the key defines the language identifier with regex and the value specifies the language TextMate scope name. By default the language identifier will be used as the language name. To change this, the value can be specified as an object with properties including `name`, `scopeName` (required), and `stripIndent`. Hover over these in VS Code to find out more. |
## Known Issues
See [Issues](https://github.com/harrydowning/vscode-yaml-embedded-languages/issues)
## Contribution Notes
See [CONTRIBUTING](CONTRIBUTING.md)
## Release Notes
See [CHANGELOG](CHANGELOG.md)