qmk_firmware/docs/api_overview.md

16 lines
901 B
Markdown
Raw Normal View History

2020-02-24 07:37:25 +01:00
# QMK API
The QMK API provides an asynchronous API that Web and GUI tools can use to compile arbitrary keymaps for any keyboard supported by [QMK](https://qmk.fm/). The stock keymap template supports all QMK keycodes that do not require supporting C code. Keyboard maintainers can supply their own custom templates to enable more functionality.
2020-02-24 07:37:25 +01:00
## App Developers
2024-05-30 04:00:41 +02:00
If you are an app developer interested in using this API in your application you should head over to [Using The API](api_docs).
2020-02-24 07:37:25 +01:00
## Keyboard Maintainers
2024-05-30 04:00:41 +02:00
If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](reference_configurator_support) section.
2020-02-24 07:37:25 +01:00
## Backend Developers
2024-05-30 04:00:41 +02:00
If you are interested in working on the API itself you should start by setting up a [Development Environment](api_development_environment), then check out [Hacking On The API](api_development_overview).