About axe DevTools Linter
Overview of axe DevTools Linter and this documentation site
Axe DevTools Linter allows you to lint your code for accessibility issues (similarly to how a code linter checks for coding issues). It is easy to configure and use. It can check React (.js, .jsx, and .tsx), Vue (.vue), Angular (.component.html, note that checking inline Angular templates is not currently supported), HTML (.html, .htm, and .xhtml), and Markdown (.md and .markdown) files so you can avoid common accessibility defects.
Editions of Linter
There are two editions of axe DevTools Linter:
- The first, axe DevTools Linter Software as a Service (SaaS), is a cloud-based service provided by Deque. It's referred to as axe DevTools Linter SaaS in this documentation when it's required to distinguish it from the other edition of axe DevTools Linter.
- The second, axe DevTools Linter On-Premises Server is a server you can install on a Linux machine to provide accessibility linting services in your organization. It requires no authentication, so it is only suitable for use behind a firewall.
Local Linting
The axe DevTools Connector command-line tool supports local linting, which lints your files locally without sending the file's content to a server. You can find more information about using local linting in the Local Linting section of the axe DevTools Linter Connector article.
Documentation Overview
In this section of the documentation, you'll find the following:
Obtaining an axe DevTools Linter SaaS API Key shows you how you can obtain a key to allow you access to Deque's cloud-based axe DevTools Linter SaaS.
If you use the software-as-a-service version, axe DevTools Linter SaaS, you don't have to set up a server and can begin using axe DevTools Linter services immediately. You only need an API key to start using its services.
Downloading the axe DevTools Linter Connector gives you information about how to obtain axe DevTools Linter Connector, which is described in the documentation for the axe DevTools Linter Connector.
Accessibility Rules lists all of the rules that axe DevTools Linter checks when it lints your code for accessibility issues. Each rule is linked to more details on Deque University.
Configuring axe DevTools Linter provides the configuration options understood by the VS Code extension, the JetBrains plugin, or the REST API /lint-source endpoint.
The sections following this one include:
Installation and Security contains articles that tell you how to install the on-premises server and encrypt its traffic using NGINX as a reverse proxy.
Using axe DevTools Linter shows various ways you can use axe DevTools Linter to check code against Deque's accessibility rules and how to integrate it with Jenkins, a GitHub pre-commit hook, a GitHub action, and SonarQube. A discussion of the JetBrains plugin and the VS Code extension is also contained in this section.
Linting Custom Components discusses the features of axe DevTools Linter for linting custom components. There are two walkthroughs in this section. The first is for users of the VS Code extension or JetBrains plugin, and the second is for users of the REST linting service. There is also an article describing support for preconfigured component libraries.
Developing with the REST APIs describes how to access axe DevTools Linter programmatically using its REST interface.
Note: It is never necessary to use Deque's software or services in a way that collects, stores, or shares personal data. Do not use the software or services in a manner that collects, stores, or shares personal data.