Skip to content

magicsandbox/monaco-yaml

 
 

Repository files navigation

Monaco YAML

YAML language plugin for the Monaco Editor. It provides the following features when editing YAML files:

  • Code completion, based on JSON schemas or by looking at similar objects in the same file
  • Hovers, based on JSON schemas
  • Validation: Syntax errors and schema validation
  • Formatting
  • Document Symbols
  • Syntax highlighting
  • Automatically load remote schema files (by enabling DiagnosticsOptions.enableSchemaRequest)

Schemas can also be provided by configuration. See here for the API that the JSON plugin offers to configure the JSON language support.

Installing

yarn add monaco-yaml See test/index.html as an example. Currently only load with vs loader is supported. (AMD) Load with ESM is added, but not yet tested.

Development

  • git clone https://github.com/pengx17/monaco-yaml
  • cd monaco-yaml
  • yarn
  • open $/monaco-yaml/demo/index.html in your favorite browser.

A running example: demo-image

Credits

Maintain

Manually clone dependencies list below and update the project files accordingly:

License

MIT

About

YAML plugin for the Monaco Editor

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.2%
  • JavaScript 0.8%