diff --git a/docs/index.rst b/docs/index.rst index 97e1fc7..958c951 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,3 +26,4 @@ Table of contents disable_with_comments development text_editors + integration diff --git a/docs/integration.rst b/docs/integration.rst new file mode 100644 index 0000000..131aa29 --- /dev/null +++ b/docs/integration.rst @@ -0,0 +1,16 @@ +Integration with other software +=============================== + +Integration with pre-commit +--------------------------- + +You can integrate yamllint in `pre-commit `_ tool. +Here is an example, to add in your .pre-commit-config.yaml + +.. code:: yaml + + # Update the sha variable with the release version that you want, from the yamllint repo + - repo: https://github.com/adrienverge/yamllint.git + sha: v1.8.1 + hooks: + - id: yamllint