Zacess Profile documentation

One file of reading needs, checked and written for every terminal, editor and web page.

These pages describe Zacess Profile v1.0.0, read from zacesshq/profile on GitHub. Start with Install Zacess Profile.

  • Quick start

    Check one of the ten starter profiles, then write its files into a folder of your choosing

  • Writing a profile

    A profile records what a person needs to read a screen comfortably: contrast floors, a font and size, spacing, cursor size and freedom from motion.

  • What is checked

    Every pair is measured with the WCAG 2.2 contrast formula and held to a floor from [needs.contrast]. The defaults follow the Zacess themes.

  • Colour vision checks

    Contrast alone does not keep two colours apart. A red and a green with the same contrast on the background can look the same to a person with a colour vision

  • Targets

    ACCESSIBILITY.md lists each need per app, including where an app has no setting for one.

  • Load the files in each app

    zprf render writes files only inside the folder given to --out. It never edits an app's real config.

  • Starter profiles

    All ten Zacess themes ship as complete profiles. Each one passes check with no colour left to derive. The project's CI keeps it that way.

  • Browser extension

    A WebExtension (Manifest V3, TypeScript, no framework) that applies a Zacess Profile to every web page through CSS custom properties.

  • System settings preview

    zprf os --print prints the system accessibility settings a profile maps to. It is a preview only: zprf never runs the lines it prints and has no option to.

  • Accessibility of Zacess Profile

    Zacess Profile exists so that a person's reading needs are written down once and kept everywhere.

  • Troubleshooting

    The messages zprf prints and what to do about each, with the limits the project's accessibility statement lists.