Skip to content

Commit

Permalink
Describe options.
Browse files Browse the repository at this point in the history
  • Loading branch information
icemac committed Feb 14, 2024
1 parent 94d948b commit 55727b3
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,40 @@
pre-commit-check-chameleon
==========================

Purpose: Check for syntax and accessibility misuse in Chameleon templates.
Purpose
-------

Usage in ``.pre-commit-config.yaml``:
Check for syntax and accessibility misuse in Chameleon templates.



Usage
-----

In ``.pre-commit-config.yaml`` add:

.. code:: yaml
- repo: https://github.com/minddistrict/pre-commit-check-chameleon
rev: 1.0
hooks:
- id: check-chameleon
Options
-------

a11y-lint-exclude
+++++++++++++++++

Exclude files in the given path from the accessibility checks, so they just get
checked for correct XML syntax.

Example:

.. code:: yaml
- repo: https://github.com/minddistrict/pre-commit-check-chameleon
rev: 1.0
hooks:
- id: check-chameleon
args: [--a11y-lint-exclude=src/module_a/module_b/templates]

0 comments on commit 55727b3

Please sign in to comment.