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

29 lines
987 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 with yaml-jsyaml or yaml-ruby. The flycheck YAML
documentation can be found at the [[http://www.flycheck.org/en/latest/languages.html#yaml][flycheck website]].
Please notice that yaml-jsyaml requires node-js package js-yaml and that yaml-ruby requires ruby installed
on your system to work.