This repository has moved to https://code.haverbeke.berlin/codemirror/lang-yaml

@codemirror/lang-yaml

[ WEBSITE | ISSUES | FORUM | CHANGELOG ]

This package implements YAML language support for the CodeMirror code editor.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

The initial implementation of this package was funded by Braintrust Data.

Usage

import{EditorView,basicSetup}from"codemirror"import{yaml}from"@codemirror/lang-yaml"constview=newEditorView({parent: document.body,doc: `name: Ferdinand\nage: 93`,extensions: [basicSetup,yaml()]})

API Reference

yaml() → LanguageSupport

Language support for YAML.

yamlLanguage: LRLanguage

A language provider based on the Lezer YAML parser, extended with highlighting and indentation information.

yamlFrontmatter(config: {content: Language | LanguageSupport}) → LanguageSupport

Returns language support for a document parsed as config.content with an optional YAML "frontmatter" delimited by lines that contain three dashes.