Рекомендации по кодированию HTML
Мы используем шаблоны Django для создания HTML.
Проверка HTML
Мы используем curlylint для проверки шаблонов и djhtml для их форматирования. Если вы установили зависимости для тестирования Wagtail (pip install -e .[testing]), вы можете проверить свой код, выполнив make lint, а отформатировать его, выполнив make format. Также вы можете выполнить make lint-client для проверки и make format-client для форматирования только файлов фронтенда (html/css/js).
Принципы
- Создавайте валидный HTML. Мы используем доктайп HTML5.
- Используйте семантический HTML.
- Следуйте практическим рекомендациям по ARIA, в частности лучше отсутствие ARIA, чем плохое ARIA.
- Привязывайте поведение JavaScript с помощью
data-атрибутов, а не классов или идентификаторов. - Для комментариев используйте синтаксис шаблонов Django, а не HTML.
© 2014-present Torchbox Ltd and individual contributors.
All rights are reserved.
Licensed under the BSD License.
https://docs.wagtail.org/en/v3.0.3/contributing/html_guidelines.html