Topic

YAML

Last updated August 22, 2017

YAML, which stands for YAML Ain't Markup Language, is a human-readable data serialization format that's been widely adopted in a variety of use cases in Drupal 8. Anyone wanting to write modules or themes for Drupal 8 will need to understand YAML syntax. Even site-builders are likely to encounter YAML, at least in passing, as YAML is the data serialization format of choice for Drupal 8's configuration management system as well.

You can spot YAML files in your Drupal codebase by looking for the .yml extension.

Example tasks

  • Review updated/exported configuration prior to deploying it to the live site
  • Use YAML files in a theme to provide metadata about the theme, asset libraries, and more
  • Work with YAML files in a module to define routes, menu items, and basic module information

Confidence

YAML syntax is not likely to change, nor is Drupal's use of it. If anything, the specific key/value pairs that Drupal uses will evolve over time.

Drupalize.Me resources

More Guides

We have guides on many Drupal skills and topics.

Explore guides

External resources

  • yaml.org
    • Canonical source for information about the YAML language.
  • YAML Syntax Validator (codebeautify.org)
    • YAML syntax validation tool, useful for locating errors in a YAML file.