spacemacs/layers/+lang/yaml/README.org

30 lines
1,011 B
Org Mode

#+TITLE: YAML layer
#+TAGS: dsl|layer|markup|programming
* Table of Contents :TOC_5_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#syntax-checking-with-flycheck][Syntax checking with flycheck]]
* Description
This layer provides support for the YAML file format.
** Features:
- Syntax highlighting
- Syntax checking via [[http://www.flycheck.org/en/latest/languages.html#yaml][flycheck]]
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =yaml= to the existing =dotspacemacs-configuration-layers= list in this
file.
* Syntax checking with flycheck
Flycheck checks YAML files with either:
- =yaml-yamllint= (requires =yamllint=)
- =yaml-jsyaml= (requires the =node-js= package =js-yaml=)
- or =yaml-ruby= (requires that =ruby= is installed on your system)
The flycheck YAML documentation can be found at the [[http://www.flycheck.org/en/latest/languages.html#yaml][flycheck website]].