About the axe-linter Server
The axe-linter Server allows you to check your code for accessibility issues (similarly to how a code linter checks for coding issues). The server is easy to configure and use, and it can check React (.js, .jsx, and .tsx), Vue (.vue), Angular (.component.html), HTML (.html and .htm), and Markdown (.md and .markdown) files so you can avoid common accessibility defects.
Checking inline Angular templates is not currently supported.
There are two types of the axe-linter Server:
- The first type, axe-linter Software as a Service (SaaS), is a cloud-based service provided by Deque. It's referred to as axe-linter SaaS in this documentation when it's required to distinguish it from the other type of axe-linter server.
- The second type, axe-linter On-Premises Server or simply the axe-linter Server, is a server you can install on a Linux machine to provide accessibility linting services in your organization. It requires no authentication to use, so it is only suitable for use behind a firewall.
In this section of the documentation, you'll find the following:
Obtaining an axe-linter SaaS API Key shows you how you can obtain a key to allow you access to Deque's cloud-based axe-linter SaaS.
If you use the software-as-a-service version, axe-linter SaaS, you don't have to set up a server and can begin using axe-linter services immediately. You only need an API key to start using its services.
Downloading the axe-linter-connector gives you information about how to obtain the axe-linter Connector, which is described in the documentation for the axe-linter Connector.
Accessibility Rules lists all of the rules that the axe-linter Server checks when it lints your code for accessibility issues. Each rule is linked to more details on Deque University.
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 the axe-linter Server shows various ways you can use the axe-linter Server to check code against Deque's accessibility rules and how to integrate it with Jenkins, GitHub, and SonarQube.
Developing with the REST APIs describes how to access the axe-linter Server programmatically using its REST interface.