@visi/prelude v0.3.1

Visible

Visible is a tool-chain that helps developers to build better websites from the perspective of accessibility.

🚧 This project is still working in progress and is not guaranteed to work properly.

Try out the web version!

Features

• 🔎 Validate ― You can diagnose your website just by typing the URL.
• 🤖 Suggestion ― Visible is not just a linter, but also provide you a patches to fix the problem by partly using AI platforms.
• 🤓 Hackable ― Visible supports plugins so you can create your own rules or algorithms of suggestion.

Installation (CLI)

npm i @visi/core @visi/cli

Requirements

• Node.js (LTS)
• npm / yarn

By default, @visi/cli does not install any rules or drivers. So if you want to use @visi/plugin-puppeteer and @visi/plugin-wcag, you'd also need:

npm i @visi/plugin-puppeteer @visi/plugin-wcag

Then, create a .visiblerc file. See documentation of config for the detail.

{
  "plugins": [
    "@visi/plugin-puppeteer",
    "@visi/plugin-wcag",
  ],
  "driver": "@visi/plugin-puppeteer",
  "rules": ["@visi/plugin-wcag"],
}

Finally, you can run visible command. You can use --help to show helps.

visible --url https://example.com

Contribution

See CONTRIBUTING.md

Code of Conduct

See CODE_OF_CONDUCT.md

License

See LICENSE