diff --git a/README.rst b/README.rst index 24079d9..718e39c 100644 --- 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 index 87a6525..e127160 100644 --- 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 `_, a + great linting tool for Javascript. + +Table of contents +----------------- + .. toctree:: :maxdepth: 2 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 9c6de28..6c20f38 100644 --- 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 `_, a great linting tool for Javascript. diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..c135b04 Binary files /dev/null and b/docs/screenshot.png differ