Candelabra is a web crawler designed to generate a sitemap from an entry URL and audit each of its pages for semantic HTML and accessibility violations. Using Candelabra, you can check any website for accessibility violations. More importantly, you can point it to local servers and other developer environments to test your code before you deploy.
It works out of the box for any website that doesn't require authentication on entry. This means it can audit any JavaScript-rendered website including those built with the popular front-end frameworks: React, Vue, Ember, Angular, etc.
Want to read more about Candelabra? Check out the wiki.
Candelabra was designed to require no configuration. Simply install the package and fire it up. For detailed usage, see Options.
# install the package
yarn global add candelabra
# run the utility
candelabra <entry-url>| Flag | Description |
|---|---|
| -V, --version | output the version number |
| -o, --output | file path to output JSON, defaults to displaying inline |
| -g, --groupBy | SEVERITY / PAGE / RULE, defaults to SEVERITY |
| -l, --limit | limit the number of URLs to crawl, defaults to 1000 |
| -h, --help | output usage information |
Use candelabra -h for a current list of options while development continues.
Simply clone the repository and get to work! Create pull requests against the repository to merge code in.
# clone the repo
git clone https://github.com/sanctuarycomputer/candelabra.git
# build the changes
yarn build
# run developer instance against a website
node lib/index.js <entry-url> <options>Feel free to make an issue if something isn't working properly or if you think there's a way to enhance the experience.