monaco-yaml/README.md
2018-03-27 11:31:02 +08:00

898 B

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

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

Installing

TODO: Document exact distribution method

Development

  • git clone https://github.com/kpdecker/monaco-yaml
  • cd monaco-yaml
  • yarn
  • npm run watch
  • open $/monaco-yaml/test/index.html in your favorite browser.

License

MIT