VIA Website - Your keyboard's best friend

VIA is a powerful, open-source web-based interface for configuring your QMK-powered mechanical keyboard. It allows you to customize your keymaps, create macros, and adjust RGB settings (if it has RGB) on the fly, without needing to recompile your keyboard's firmware. This makes keyboard customization easier and more accessible for everyone.

Getting VIA to support your keyboard

Are you a keyboard maker or a developer interested in adding support for your keyboard? We welcome contributions to the VIA project!

1. The keyboard implementation must be merged into the QMK Firmware repository master branch.
2. Its keymaps/via keymap must be merged into VIA's QMK Userspace repository main branch.
3. Its JSON definition must be submitted to the VIA Keyboards repository master branch.

Please follow our Specification documentation carefully to ensure your pull request is smoothly reviewed and merged.

Local development setup

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Facing Issues?

If you encounter any issues or bugs while using the VIA Web Application, please report them by opening an issue in the VIA Web Application Repository. This will help us to track down and resolve problems, and improve the VIA experience for everyone.

Before reporting, please make sure to check if an issue has already been reported. Thank you!