Doc: Add a screenshot

adrienverge · Jan 23, 2016 · fee72d4 · fee72d4
1 parent 387d14f
commit fee72d4
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/README.rst b/README.rst
@@ -25,6 +25,12 @@ http://yamllint.readthedocs.org/
 Short overview
 --------------
 
+Screenshot
+^^^^^^^^^^
+
+.. image:: docs/screenshot.png
+   :alt: yamllint screenshot
+
 Installation
 ^^^^^^^^^^^^
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -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
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -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.
diff --git a/docs/screenshot.png b/docs/screenshot.png