Doc: Add a screenshot

This commit is contained in:
Adrien Vergé
2016-01-23 14:30:24 +01:00
parent 387d14f816
commit fee72d484e
4 changed files with 21 additions and 6 deletions

View File

@@ -3,6 +3,20 @@ yamllint documentation
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::
:maxdepth: 2

View File

@@ -33,7 +33,7 @@ You can also lint all YAML files in a whole directory:
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
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.

BIN
docs/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB