yamllint documentation
======================

A linter for YAML files.

yamllint does not only check for syntax validity, but for common cosmetic
conventions such as lines length, trailing spaces, indentation, etc.

Screenshot
----------

.. image:: screenshot.png
   :alt: yamllint screenshot

.. note::

   The default output format is inspired by `eslint <http://eslint.org/>`_, a
   great linting tool for Javascript.

Table of contents
-----------------

.. toctree::
   :maxdepth: 2

   quickstart
   configuration
   rules
   development
   text_editors