Joe Strong 2013f63134 Fixes small typo in docs (#10515)		4 yıl önce
..
ChangeLog	c56b9a1ce9 Add ChangeLog for 2020 Aug 29 Breaking Changes	4 yıl önce
de	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
es	72d3270547 Remove `DESCRIPTION` (#9732)	4 yıl önce
fr-fr	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
gitbook	4580d3a730 RGB improvements (#1684)	7 yıl önce
he-il	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
ja	9e9b604234 Mark 'key_count' as optional within info.json docs (#10513)	4 yıl önce
pt-br	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
ru-ru	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
zh-cn	5bd239e1c0 Remove unnecessary break after return from documentation (#9892)	4 yıl önce
.nojekyll	9e5676650e Use docsfy to replace gitbook	7 yıl önce
CNAME	4d26137e2a Create CNAME	7 yıl önce
README.md	961477c791 make sure all our redirects are in order	5 yıl önce
_langs.md	10e8ed7430 [Docs] add README translation in portuguese (#7016)	5 yıl önce
_summary.md	d4be07dad3 Hid joystick interface (#4226)	4 yıl önce
adc_driver.md	8a4a0c25fd Change analogRead calls to analogReadPin (#9023)	4 yıl önce
api_development_environment.md	99850aabca Add API documentation	5 yıl önce
api_development_overview.md	99850aabca Add API documentation	5 yıl önce
api_docs.md	99850aabca Add API documentation	5 yıl önce
api_overview.md	99850aabca Add API documentation	5 yıl önce
arm_debugging.md	52c18ef026 [Docs] fix docs (#7642)	5 yıl önce
breaking_changes.md	000eb14d78 update "Breaking Changes" doc	4 yıl önce
breaking_changes_instructions.md	fced377ac0 2020 May 30 Breaking Changes Update (#9215)	5 yıl önce
cli.md	fcf150bd82 Streamline the macos install process	5 yıl önce
cli_commands.md	751316c344 [CLI] Add a subcommand for getting information about a keyboard (#8666)	5 yıl önce
cli_configuration.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
cli_development.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
coding_conventions_c.md	f4b67cde8a Update C coding conventions to match .clang-format config for i… (#8717)	5 yıl önce
coding_conventions_python.md	66d94dc22a Move everything to Python 3.6 (#8835)	5 yıl önce
compatible_microcontrollers.md	7aa4cc9603 adds support for the atmega328 (#9043)	5 yıl önce
config_options.md	0f596881b3 Remove support for Adafruit EZ-Key (#10103)	4 yıl önce
configurator_step_by_step.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
configurator_troubleshooting.md	d5f34c4810 Polish Configurator section	5 yıl önce
contributing.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
custom_matrix.md	6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906)	5 yıl önce
custom_quantum_functions.md	5bd239e1c0 Remove unnecessary break after return from documentation (#9892)	4 yıl önce
documentation_best_practices.md	995464cb9c [Docs] fix file path (#9540)	5 yıl önce
documentation_templates.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
driver_installation_zadig.md	19b70b2737 MSYS2: Switch to bootloadHID package and bring back avrdude package (#9736)	4 yıl önce
eeprom_driver.md	54b04d9665 Add SPI 25xx EEPROM support. (#8780)	5 yıl önce
faq_build.md	a0305f5e7e Be more specific about Caterina devices, and add LilyPad PID	4 yıl önce
faq_debug.md	72b1ff5899 Add TMK "FEED" VID to list of deprecated udev rules	4 yıl önce
faq_general.md	a701c15d87 Rework the newbs guide around the qmk cli	5 yıl önce
faq_keymap.md	12e43230c6 make custom_keycode_names.md a faq entry instead	5 yıl önce
feature_advanced_keycodes.md	0cb7133e0d Doc followup 9942 (#10473)	4 yıl önce
feature_audio.md	d534c72a54 Added keycodes for swapping and unswapping the Control and OS keys (#6110)	5 yıl önce
feature_auto_shift.md	568cae28ec #define AUTO_SHIFT_SETUP (#8441)	4 yıl önce
feature_backlight.md	15b5ff1dc2 Remove f072 backlight warning (#10040)	4 yıl önce
feature_bluetooth.md	0fbb1e550a Add description in Bluetooth docs for requiring NKRO to be disabled (#10359)	4 yıl önce
feature_bootmagic.md	789e199450 Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347)	5 yıl önce
feature_combo.md	57540af102 Change "yu" to "you" in combo docs (#6510)	5 yıl önce
feature_command.md	a2e91ebec9 Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348)	5 yıl önce
feature_debounce_type.md	f7ccbfcea8 quantum/debounce: rename debouncing algorithms (#9564)	4 yıl önce
feature_dip_switch.md	c2ca57c8f4 add DIP_SWITCH_MATRIX_GRID support (#8772)	5 yıl önce
feature_dynamic_macros.md	cdb69da86e Fix typo in docs/feature_dynamic_macros (#10085)	4 yıl önce
feature_encoders.md	b7da69ec85 Adding information to feature_encoders.md (#9486)	5 yıl önce
feature_grave_esc.md	3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483)	6 yıl önce
feature_haptic_feedback.md	f275ffbdfc Minor grammar and filename fixes in docs (#7559)	5 yıl önce
feature_hd44780.md	d846660e00 fixed typo for clear lcd screen function in hd44780 docs (#9086)	5 yıl önce
feature_joystick.md	bdd8d2679b Allow joysticks to be used without analog pins (#10169)	4 yıl önce
feature_key_lock.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
feature_layers.md	61b64bb82a Redefine IS_LAYER_ON/OFF() as aliases for existing layer functions (#6352)	4 yıl önce
feature_layouts.md	40e67a3074 Add a mechanism for force building a particular community layout (#5027)	6 yıl önce
feature_leader_key.md	294cfd8d33 Delete trailing period in documentation (#9416)	5 yıl önce
feature_led_matrix.md	24df54b807 Add documentation for led matrix	6 yıl önce
feature_macros.md	02781979d6 [Docs] Improve Unicode documentation (#8676)	5 yıl önce
feature_mouse_keys.md	19006c9753 Implemented New MK_COMBINED Functionality (#9557)	4 yıl önce
feature_oled_driver.md	c23667608c Add OLED driver function to determine if the screen is currently on (#10382)	4 yıl önce
feature_pointing_device.md	573d1fbb92 Include `pointing_device_send` in docs (#9185)	5 yıl önce
feature_ps2_mouse.md	b7dc2eb9ab Add movement hook to ps2_mouse (#8805)	5 yıl önce
feature_rawhid.md	d1df576ece Allow for overriding RAW endpoint usage page and ID. (#8834)	5 yıl önce
feature_rgb_matrix.md	bc15c4f4ab Update led_conf_t example (#10327)	4 yıl önce
feature_rgblight.md	4b74f985ec Tweak the Christmas animation effect to be less harsh on the eyes (#7648)	4 yıl önce
feature_space_cadet.md	d16db69367 Added mod carry over from press to release. (#5866)	6 yıl önce
feature_split_keyboard.md	088888937a Replace figures in docs/feature_split_keyboard.md (#10242)	4 yıl önce
feature_stenography.md	64603ab647 fix typo (#9695)	4 yıl önce
feature_swap_hands.md	805f5cb72b One shot support for swap hands (#8590)	5 yıl önce
feature_tap_dance.md	9d3b26a475 Update features to use Custom Tapping Term when appropriate (#6259)	4 yıl önce
feature_terminal.md	b23f6011c3 Remove build option firmware size impacts (#6947)	5 yıl önce
feature_thermal_printer.md	4c675a83ba Format keycode tables	7 yıl önce
feature_unicode.md	02781979d6 [Docs] Improve Unicode documentation (#8676)	5 yıl önce
feature_userspace.md	2543bad250 [Docs] Fixed the hyperlink to `/users/_example/`. (#9326)	5 yıl önce
feature_velocikey.md	c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754)	6 yıl önce
feature_wpm.md	bfb2f8e0a8 Add Word Per Minute calculation feature (#8054)	5 yıl önce
flashing.md	d00ac5dfb6 Add `st-flash` flash target (#9964)	4 yıl önce
flashing_bootloadhid.md	235da6973d Install bootloadHid as part of qmk_install (#7463)	5 yıl önce
fuse.txt	ca01d94005 convert docs to lowercase and underscores	8 yıl önce
getting_started_docker.md	0fbcb41c85 Reintegrate previous docker docs (#9084)	5 yıl önce
getting_started_github.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
getting_started_introduction.md	09c7304bd9 [Docs] update git command and directory name of documents (#7619)	5 yıl önce
getting_started_make_guide.md	0f596881b3 Remove support for Adafruit EZ-Key (#10103)	4 yıl önce
getting_started_vagrant.md	bc13dcd349 Remove Atmel FLIP from install scripts and documentation (#8822)	5 yıl önce
hand_wire.md	961477c791 make sure all our redirects are in order	5 yıl önce
hardware_avr.md	72d3270547 Remove `DESCRIPTION` (#9732)	4 yıl önce
hardware_drivers.md	d13ada1162 Add customisable EEPROM driver selection (#7274)	5 yıl önce
hardware_keyboard_guidelines.md	2013f63134 Fixes small typo in docs (#10515)	4 yıl önce
how_a_matrix_works.md	a95a314f78 refactor How a Matrix Works doc	5 yıl önce
how_keyboards_work.md	d5316e9714 Update URL for `60-keyboard.hwdb` (#7185)	5 yıl önce
i2c_driver.md	346bfb2a05 Update i2c_driver.md (#10131)	4 yıl önce
index.html	e182a38e7c Add redirect for old getting started links (#8987)	5 yıl önce
internals_defines.md	ae7284edb8 rename api docs to internals	7 yıl önce
internals_gpio_control.md	d26a14c169 add 'togglePin' convenience function (#8734)	5 yıl önce
internals_input_callback_reg.md	ae7284edb8 rename api docs to internals	7 yıl önce
internals_midi_device.md	ae7284edb8 rename api docs to internals	7 yıl önce
internals_midi_device_setup_process.md	ae7284edb8 rename api docs to internals	7 yıl önce
internals_midi_util.md	ae7284edb8 rename api docs to internals	7 yıl önce
internals_send_functions.md	ae7284edb8 rename api docs to internals	7 yıl önce
internals_sysex_tools.md	ae7284edb8 rename api docs to internals	7 yıl önce
isp_flashing_guide.md	c4d778a302 [Docs] Update ISP Guide (#9748)	4 yıl önce
keycodes.md	b4ae7badd4 Issue 9942: Add LSA, RSA, RCS, LSA_T, RSA_T, and RCS_T (#9943)	4 yıl önce
keycodes_basic.md	370577e4ed Add OPT aliases for ALT keycodes and macros (#8714)	5 yıl önce
keycodes_us_ansi_shifted.md	40de65eac4 Backslash-escape pipe character in keycode lists (#7157)	5 yıl önce
keymap.md	142ebaea46 [Docs] Clarify layer transparency keymap.md (#9081)	5 yıl önce
mod_tap.md	0cb7133e0d Doc followup 9942 (#10473)	4 yıl önce
newbs.md	45e218ceec overhaul the newbs guide	5 yıl önce
newbs_building_firmware.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
newbs_building_firmware_configurator.md	d5f34c4810 Polish Configurator section	5 yıl önce
newbs_flashing.md	9c8f61dfa0 [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro (#9077)	5 yıl önce
newbs_getting_started.md	32340e14fb Update newbs MSYS2 pacman instructions (#9445)	5 yıl önce
newbs_git_best_practices.md	3152bf572b [Docs] Restructure of Git Best Practices doc (#7231)	5 yıl önce
newbs_git_resolving_merge_conflicts.md	3152bf572b [Docs] Restructure of Git Best Practices doc (#7231)	5 yıl önce
newbs_git_resynchronize_a_branch.md	26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728)	5 yıl önce
newbs_git_using_your_master_branch.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
newbs_learn_more_resources.md	45e218ceec overhaul the newbs guide	5 yıl önce
newbs_testing_debugging.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
one_shot_keys.md	8e0af2f5ba [Docs] Fix link to mod_tap.md in the one_shot_keys.md file (#9380)	5 yıl önce
other_eclipse.md	cde5237a88 fix two links on docs/other_eclipse.md (#8417)	5 yıl önce
other_vscode.md	6499eb6a3c Fixed typo in vscode docs (#10303)	4 yıl önce
platformdev_chibios_earlyinit.md	93e7a8f74c Add dual-bank STM32 bootloader support, given GPIO toggle on BOOT0 to charge RC circuit. (#8778)	4 yıl önce
platformdev_selecting_arm_mcu.md	3afd2d81b8 Add documentation for selecting an Arm MCU (#9046)	5 yıl önce
power.txt	bb53635f33 Trim trailing whitespace	7 yıl önce
pr_checklist.md	ac24f203cc Docs/PR_checklist: Reorder, unify and pet-peeves (#10253)	4 yıl önce
proton_c_conversion.md	6d84795bc1 Update ARM split keyboard docs (#9160)	5 yıl önce
qmk.css	ccc87421e7 Some more tweaks to make everything look nice	7 yıl önce
qmk_custom_dark.css	1b267d4840 Fix darkmode (#8393)	5 yıl önce
qmk_custom_light.css	1b267d4840 Fix darkmode (#8393)	5 yıl önce
quantum_keycodes.md	54c58ea6de Add explicit id tags to externally linked headers	5 yıl önce
redirects.json	d569f08771 Configuration system for CLI (#6708)	5 yıl önce
ref_functions.md	2f637e4ea1 [Docs] Clarify functionality of update_tri_layer_state (#10370)	4 yıl önce
reference_configurator_support.md	d5f34c4810 Polish Configurator section	5 yıl önce
reference_glossary.md	29ebb99b1f fixed link to Eclipse instructions (#9647)	5 yıl önce
reference_info_json.md	9e9b604234 Mark 'key_count' as optional within info.json docs (#10513)	4 yıl önce
reference_keymap_extras.md	5f9fb01020 [Keymap Extra] Add French AZERTY (AFNOR - NF Z71-300) (#9644)	4 yıl önce
serial_driver.md	6d84795bc1 Update ARM split keyboard docs (#9160)	5 yıl önce
spi_driver.md	7aa4cc9603 adds support for the atmega328 (#9043)	5 yıl önce
support.md	e4823aadec Fix capitalisation of "GitHub" (#9184)	5 yıl önce
sw.js	303f425c6b Fix up info boxes.	7 yıl önce
syllabus.md	9b70e53508 [Docs] Fixed minor typos (#8860)	5 yıl önce
tap_hold.md	28ff51175b [Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces (#10391)	4 yıl önce
translating.md	7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504)	5 yıl önce
understanding_qmk.md	5117dff6a2 Add Post Processing to process_record (#4892)	5 yıl önce
unit_testing.md	e02a3c559d Edit Unit Testing Documentation (#8961)	5 yıl önce
usb_nkro.txt	995c3141a6 convert docs to lowercase and underscores	8 yıl önce
ws2812_driver.md	c6b7a0d386 Add support for DMAMUX-capable MCU configuration with WS2812 PWM driver. (#9471)	4 yıl önce

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains QMK Firmware, QMK Configurator, QMK Toolbox, qmk.fm, and this documentation with the help of community members like you.

Get Started

Totally new to QMK? There are two ways to get started:

Basic: QMK Configurator
- Just select your keyboard from the dropdown and program your keyboard.
- We have an introductory video you can watch.
- There is also an overview document you can read.
Advanced: Use The Source
- More powerful, but harder to use

Make It Yours

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.

Need help?

Check out the support page to see how you can get help using QMK.

Give Back

There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.

Help people out on our forums and chat rooms:
- /r/olkb
- Discord Server
Contribute to our documentation by clicking "Edit This Page" at the bottom
Translate our documentation into your language
Report a bug
Open a Pull Request