Alt text linter

This repository stores a GitHub action for linting alternative (alt) text in Quarto markdown (.qmd) files.

Alt text provides meaningful descriptions for images so that screen readers, text-based browsers, and users with low vision or limited bandwidth can understand their content. Including clear alt text improves accessibility, meets WCAG standards, and ensures research outputs are inclusive and comprehensible to all audiences.

Usage

This is currently in early development with no major tags yet, so for now you should pin to main:

- uses: lintquarto/alt-text-linter@main

You can specify a particular path to lint, for example:

- uses: lintquarto/alt-text-linter@main
  with:
    path: docs/

Example

name: Check Alt Text
run-name: Check Alt Text

on:
  push:
    paths:
      - '**.qmd'
  pull_request:
    paths:
      - '**.qmd'
  workflow_dispatch:

jobs:
  check-alt-text:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: lintquarto/alt-text-linter@main

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Amy Heather 💻 📖 🚧 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!