Doc: Add a screenshot

pull/4/head
Adrien Vergé 9 years ago
parent 387d14f816
commit fee72d484e

@ -25,6 +25,12 @@ http://yamllint.readthedocs.org/
Short overview Short overview
-------------- --------------
Screenshot
^^^^^^^^^^
.. image:: docs/screenshot.png
:alt: yamllint screenshot
Installation Installation
^^^^^^^^^^^^ ^^^^^^^^^^^^

@ -3,6 +3,20 @@ yamllint documentation
A linter for YAML files. A linter for YAML files.
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:: .. toctree::
:maxdepth: 2 :maxdepth: 2

@ -33,7 +33,7 @@ You can also lint all YAML files in a whole directory:
yamllint . yamllint .
The output will look like (colors are not displayed here [#colored-output]_): The output will look like (colors are not displayed here):
:: ::
@ -70,8 +70,3 @@ option:
If you have a ``.yamllint`` file in your working directory, it will be If you have a ``.yamllint`` file in your working directory, it will be
automatically loaded as configuration by yamllint. automatically loaded as configuration by yamllint.
.. rubric:: Footnotes
.. [#colored-output] The default output format is colored and inspired by
`eslint <http://eslint.org/>`_, a great linting tool for Javascript.

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Loading…
Cancel
Save