HTML coding guidelines¶
We use Django templates to author HTML.
Linting HTML¶
We use curlylint to lint templates and djhtml to format them.
If you have installed Wagtail’s testing dependencies (pip install -e .[testing]
), you can check your code by running make lint
, and format your code by running make format
. Alternatively you can also run
make lint-client
for checking and make format-client
for formatting frontend (html/css/js) only files.
Principles¶
Write valid HTML. We target the HTML5 doctype.
Write semantic HTML.
Consult ARIA Authoring Practices, in particular No ARIA is better than Bad ARIA.
Attach JavaScript behavior with
data-
attributes, rather than classes or IDs.For comments, use Django templates syntax instead of HTML.