Skip to main content
Skip to docs content

Usage Guide

Learn how to use Speakable to analyze your HTML and predict screen reader output.

Quick Start

Install Speakable globally via npm, then run it against any HTML file:

Terminal
npm install -g speakable
speakable analyze ./my-page.html --engine nvda

Web Tool

The web analyzer at /tool lets you paste HTML directly and see results instantly. No installation required.

  1. Paste your HTML into the textarea
  2. Select a screen reader (NVDA, JAWS, VoiceOver, or All)
  3. Optionally enter a CSS selector to focus on specific elements
  4. Click Analyze to see the predicted output

CSS Selector Filtering

Use the CSS selector field to narrow analysis to specific elements. For example, entering button.primary will only analyze buttons with the “primary” class.

Diff Mode

Toggle diff mode to compare two HTML snippets side by side. Speakable will show you exactly which accessibility tree nodes were added, removed, or changed between the two versions.