Doc: Add a configuration example in README
This commit is contained in:
16
README.rst
16
README.rst
@@ -64,3 +64,19 @@ Usage
|
||||
|
||||
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
||||
yamllint -f parsable file.yml
|
||||
|
||||
Configuration example
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
extends: default
|
||||
|
||||
rules:
|
||||
# 80 chars should be enough, but don't fail if a line is longer
|
||||
line-length:
|
||||
max: 80
|
||||
level: warning
|
||||
|
||||
# don't bother me with this rule
|
||||
indentation: disable
|
||||
|
||||
@@ -50,7 +50,7 @@ strict on block sequences indentation:
|
||||
extends: default
|
||||
|
||||
rules:
|
||||
# 80 should be enough, but don't fail if a line is longer
|
||||
# 80 chars should be enough, but don't fail if a line is longer
|
||||
line-length:
|
||||
max: 80
|
||||
level: warning
|
||||
|
||||
Reference in New Issue
Block a user