pre-commit-hooks

Radxa-specific hooks to enforce our documentation policies

Hooks available

use-webp-image

Prevent non-webp image from being commited. svg is allowed.

Currently does not automatically convert the image.

fix-en-dash-list

Detect and fix potential misuse of en dash in Markdown list.

Development against radxa-doc/documentation

First, run pre-commit install to ensure this repo is also shell checked.

Please refer to pre-commit documentation about developing hooks interactively.

In short, run the following command in radxa-doc/documentation project folder:

pre-commit try-repo --verbose --all-files ../pre-commit-hooks
pre-commit try-repo --verbose --all-files --hook-stage manual ../pre-commit-hooks
pre-commit try-repo --verbose --all-files ../pre-commit-hooks check-folder-structure