NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2024-11-22 07:36:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Add new features in README

Browse Source
This commit is contained in:
Adrien Vergé 2016-06-27 21:29:56 +02:00
parent 8844855353
commit 71b90ae208
1 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.rst
View File

@ -24,10 +24,10 @@ Written in Python (compatible with Python 2 & 3).
Documentation Documentation
------------- -------------
http://yamllint.readthedocs.org/ http://yamllint.readthedocs.io/
Short overview Overview
-------------- --------
Screenshot Screenshot
^^^^^^^^^^ ^^^^^^^^^^
@ -82,8 +82,12 @@ Usage
# Output a parsable format (for syntax checking in editors like Vim, emacs...) # Output a parsable format (for syntax checking in editors like Vim, emacs...)
yamllint -f parsable file.yaml yamllint -f parsable file.yaml
Configuration example `Read more in the complete documentation! <http://yamllint.readthedocs.io/>`_
^^^^^^^^^^^^^^^^^^^^^
Features
^^^^^^^^
Here is a yamllint configuration file example:
.. code:: yaml .. code:: yaml
@ -97,3 +101,22 @@ Configuration example
# don't bother me with this rule # don't bother me with this rule
indentation: disable indentation: disable
Within a YAML file, special comments can be used to disable checks for a single
line:
.. code:: yaml
This line is waaaaaaaaaay too long # yamllint disable-line
or for a whole block:
.. code:: yaml
# yamllint disable rule:colons
- Lorem : ipsum
dolor : sit amet,
consectetur : adipiscing elit
# yamllint enable
`Read more in the complete documentation! <http://yamllint.readthedocs.io/>`_