Readability
readability.adaptive-enforcement-lab.com
- Free plan
- Windows
- macOS
- Linux
What Readability is
Readability analyzes Markdown files and reports measures of reading difficulty, including grade level, reading ease, and estimated reading time based on 200 words per minute. It includes Flesch-Kincaid, Gunning Fog, Coleman-Liau, SMOG, and ARI grade-level measures, along with word and sentence metrics. It can detect or require MkDocs-style admonitions and produce results as a table, Markdown, JSON, summary, or report. Configurable thresholds can fail CI checks when documentation exceeds them; a .readability.yml file supports path-specific overrides. The project documents a command-line tool, Docker, a GitHub Action, pre-commit hooks, and building from source. Its GitHub Action can add a formatted report to an Actions job summary, and CI/CD examples cover GitLab CI, CircleCI, and Jenkins. The MIT-licensed project lists binaries for Linux and macOS in amd64 and arm64, and Windows in amd64. Its scores assess word and sentence complexity, not accuracy, completeness, context, or tone.
Who it suits
Readability suits bloggers, technical writers, documentation teams, students, and others who want readability measures for Markdown. Its threshold and workflow options also fit teams checking documentation in CI.
Good to know, and what to watch
- Reports five listed grade-level formulas.
- Exports results as table, Markdown, JSON, summary, or report.
- Thresholds can fail CI checks.
- Provides a GitHub Action and pre-commit hooks.
- MIT-licensed, with free CLI and Docker options.
- Scores cannot assess accuracy, completeness, context, or tone.
- Listed Windows binary supports amd64 only.
- Analyzes Markdown files.
Plans
Every plan and priceReadability
Open source
Getting started
- Open the Readability project website
- Choose a Go CLI, Docker image, GitHub Action, pre-commit hook or source build
- Install the selected option for Linux, macOS or Windows
- Add Markdown files for analysis
- Configure thresholds or path overrides in .readability.yml
- Run the checks and review the selected output format
Limits to check
Readability scores cover sentence and word complexity, but they cannot assess accuracy, completeness, context or tone. The documented pre-built Windows binary is for amd64, while Linux and macOS binaries are listed for amd64 and arm64.
The Club's review
Readability is a free, open-source analyzer for Markdown files that turns prose complexity into repeatable scores and CI checks. It is best suited to bloggers, technical writers, documentation teams, students, and developers maintaining docs as code. Choose it when you need local, scriptable checks rather than a rewriting assistant or a hosted editor.
Overview
The tool combines several established readability formulas with reading-ease, estimated reading time, and basic word and sentence statistics. That breadth helps teams compare drafts and set a consistent standard across a documentation set instead of relying on one headline score. Its boundary is important: the measurements concern word and sentence complexity, not factual accuracy, completeness, context, or tone.
Key features
Scoring and content checks
Readability reports Flesch-Kincaid, Gunning Fog, Coleman-Liau, SMOG, and ARI grade-level scores. It also reports reading ease and estimates reading time at 200 words per minute. Word and sentence metrics add useful diagnostic detail, while checks for detecting or requiring MkDocs-style admonitions fit teams with structured documentation conventions. There are no plain-language rewrites or accessibility recommendations, so editing remains your responsibility.
Thresholds and configuration
Configurable thresholds can fail a CI check when documentation exceeds limits you set, catching complexity regressions before release. A .readability.yml file supports path-specific overrides, and the supplied JSON Schema enables editor validation and autocomplete. This combination is more suitable for repeatable team policy than for occasional, one-off scoring.
Output and integrations
Results can be emitted as a table, Markdown, JSON, summary, or report, making them usable in scripts and review artifacts. The project documents a command-line tool, Docker image, GitHub Action, and pre-commit hooks. The GitHub Action runs in workflows and can add a formatted report to the Actions job summary; CI/CD examples cover GitLab CI, CircleCI, and Jenkins. Docker guidance includes Cosign signature verification, a signed SBOM, and a distroless, non-root image, useful safeguards for security-conscious build pipelines.
Pricing
Readability costs nothing. The MIT-licensed GitHub Action, CLI, and Docker image are included, and no paid plans are listed. That makes it a strong fit for individuals and teams that can manage their own tooling and want predictable, unrestricted software costs. The trade-off is that there is no hosted support tier or paid editing service described; organizations wanting managed assistance or an interactive rewriting workflow should look elsewhere.
Platforms
Readability supports Linux, macOS, and Windows. Pre-built binaries cover Linux amd64 and arm64, macOS amd64 and arm64, and Windows amd64. Windows users on arm64 do not have a documented pre-built binary, so they may need another deployment route, such as Docker or building from source. Installation and execution are also available through Go, Docker, GitHub Actions, pre-commit hooks, or source builds.
Who it's for
Bloggers and students can use the scores to spot dense passages and monitor reading level. Technical writers and documentation teams gain more from thresholds, path-specific configuration, admonition checks, and CI integration. Developers responsible for documentation pipelines will appreciate machine-readable output and pre-commit enforcement. It is a poor match for anyone expecting automatic rewrites, accessibility advice, or a verdict on whether content is correct and complete.
Pros and cons
- Pros: Free MIT licensing removes subscription cost and permits use of the CLI, Action, and Docker image.
- Pros: Five grade-level formulas, reading ease, reading time, and word and sentence metrics provide multiple ways to track complexity.
- Pros: Threshold failures, configuration overrides, and broad CI integrations support enforceable documentation standards.
- Pros: JSON, Markdown, table, summary, and report outputs fit both automation and human review.
- Cons: It analyzes complexity but does not rewrite prose, provide accessibility guidance, or assess accuracy, completeness, context, or tone.
- Cons: The documented Windows binary is amd64 only, unlike the amd64 and arm64 binaries listed for Linux and macOS.
Alternatives
Pick APIVerve Website Readability API instead when you need a freemium web or API service with a free allowance, trials, and metered requests rather than a local Markdown tool.
Text Inspector is the better fit for a hosted API or web workflow with a 250-word free tier and automatic deletion after six hours.
Choose Hemingway Editor when you want macOS, Windows, or web access in a freemium editor that includes paid AI-sentence quotas.
ToolsVale Readability Checker suits readers wanting a free, no-account checker across mobile, desktop, and web platforms.
Health Literacy Advisor is aimed at paid health-literacy work rather than general Markdown CI checks.
PageRefine is a free, no-signup web tool.
ProfText offers a freemium web/API service with character limits and AI-generated-text detection.
Readability Formulas is a freemium option with browser, macOS, Windows, and online calculators.
For a broader selection, see AI Readability Checkers.
Verdict
Readability is the right choice for writers and documentation teams that want open-source, repeatable Markdown analysis embedded in local hooks and CI. Its main reason to choose it is enforceable, configurable scoring at no cost; its main reason to look elsewhere is the absence of rewriting, accessibility guidance, and broader editorial judgment.
The verdict
Readability offers a range of readability measures and workflow integrations at no cost. Treat its scores as complexity indicators, not a judgment of whether content is accurate or complete.
Questions people ask
Is Readability free?
Yes. The Readability plan costs nothing, and the project is MIT-licensed with no paid plans listed.
What does it analyze?
Readability analyzes Markdown files and reports grade level, reading ease, estimated reading time, word metrics and sentence metrics.
Which formulas are included?
The listed formulas are Flesch-Kincaid, Gunning Fog, Coleman-Liau, SMOG and ARI.
How can I run it?
The project documents a Go command-line tool, Docker, a GitHub Action, pre-commit hooks and building from source.
Can it enforce documentation thresholds?
Yes. Configurable thresholds can fail CI checks, and the GitHub Action can add a formatted report to an Actions job summary.
Does it rewrite text automatically?
No. Plain-language rewrites are not provided, and the scores do not determine accuracy, completeness, context or tone.
What the maker publishes
- Additional checks
- It can measure word and sentence metrics and detect or require MkDocs-style admonitions. source
- Configuration
- A .readability.yml file can set thresholds and path-specific overrides, and the project provides a JSON Schema for editor validation and autocomplete. source
- Container verification
- The repository documents verifying the Docker image signature with cosign. source
- Deployment
- It can be installed as a Go command-line tool, run through Docker, added as a GitHub Action, or built from source. source
- Docker security
- The Docker guide says images are signed with Cosign, include a signed SBOM, and use a distroless base image that runs as a non-root user. source
- GitHub integration
- The GitHub Action can run checks in workflows and add a formatted report to the Actions job summary. source
- Headquarters
- Switzerland source
- Integrations
- The project provides a GitHub Action and pre-commit hooks, and documents CI/CD examples for GitLab CI, CircleCI, and Jenkins. source
- Intended users
- The product site names bloggers, technical writers, documentation teams, students, and curious readers as audiences for its introductory material. source
- License
- The repository identifies its license as MIT. source
- Limitations
- The maker says readability scores assess sentence and word complexity and cannot determine accuracy, completeness, context, or tone. source
- Metrics
- It reports grade level, reading ease, and estimated reading time at 200 words per minute. source
- Metrics
- It reports grade level, reading ease, reading time, and scores including Flesch-Kincaid, Gunning Fog, Coleman-Liau, SMOG, and ARI. source
- Notable limit
- The documented pre-built Windows binary is for amd64; the page lists amd64 and arm64 for Linux and macOS. source
- Output formats
- Listed output formats include table, Markdown, JSON, summary, and report. source
- Platforms
- Pre-built binaries are listed for Linux amd64 and arm64, macOS amd64 and arm64, and Windows amd64. source
- Purpose
- Readability analyzes Markdown files and reports readability scores. source
- Reading formulas
- The project lists Flesch-Kincaid, Gunning Fog, Coleman-Liau, SMOG, and ARI grade-level scores. source
- Supported binaries
- Pre-built binaries are listed for Linux (amd64, arm64), macOS (amd64, arm64), and Windows (amd64). source
- Threshold checks
- Threshold enforcement can fail a CI check when content quality drops. source
- Thresholds
- Users can configure thresholds and make CI checks fail when documentation exceeds them. source
- Ways to run
- The project documents a command-line tool, a GitHub Action, a Docker image, and pre-commit hooks. source
- Who it is for
- The documentation describes use cases for bloggers, technical documentation writers, documentation teams, students, and people curious about readability. source
Checked against the maker's pages on 7 Oct 2026.