mirror/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-09-10 17:15:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f2d4dace06608b0744c7f5b33db0ad6c1411cdb8
qmk_firmware/docs
History
Jack Humbert f2d4dace06 try serving doxygen staticly
2023-04-20 12:15:44 -04:00
..
ChangeLog
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
gitbook/images
half of summary added
2023-04-18 13:44:25 -04:00
ja
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
src
resolve all links, update internals
2023-04-19 15:09:25 -04:00
static
try serving doxygen staticly
2023-04-20 12:15:44 -04:00
zh-cn
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
_summary.md
Stub changelog
2023-02-19 20:23:01 +00:00
.gitignore
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
adc_driver.md
Add analog support for RP2040 (#19453)
2023-01-19 10:30:58 +11:00
api_development_environment.md
…
api_development_overview.md
…
api_docs.md
more sidebar labels
2023-04-19 10:31:32 -04:00
api_overview.md
more sidebar labels
2023-04-19 10:31:32 -04:00
arm_debugging.md
…
audio_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
babel.config.js
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
breaking_changes_history.md
Stub changelog
2023-02-19 20:23:01 +00:00
breaking_changes_instructions.md
more sidebar labels
2023-04-19 10:31:32 -04:00
breaking_changes.md
more sidebar labels
2023-04-19 10:31:32 -04:00
chibios_upgrade_instructions.md
Update branch names to reflect configurator's new deployment. (#19999)
2023-03-03 14:16:06 +11:00
cli_commands.md
more sidebar labels
2023-04-19 10:31:32 -04:00
cli_configuration.md
more sidebar labels
2023-04-19 10:31:32 -04:00
cli_development.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
cli_tab_complete.md
more sidebar labels
2023-04-19 10:31:32 -04:00
cli.md
more sidebar labels
2023-04-19 10:31:32 -04:00
coding_conventions_c.md
docs: some typos (#18582)
2022-10-05 17:32:07 +01:00
coding_conventions_python.md
resolve all links, update internals
2023-04-19 15:09:25 -04:00
compatible_microcontrollers.md
Tentative Teensy 3.5 support (#14420)
2022-07-03 00:12:45 +10:00
config_options.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
configurator_architecture.md
more sidebar labels
2023-04-19 10:31:32 -04:00
configurator_default_keymaps.md
more sidebar labels
2023-04-19 10:31:32 -04:00
configurator_diagram.drawio
…
configurator_diagram.svg
…
configurator_step_by_step.md
more sidebar labels
2023-04-19 10:31:32 -04:00
configurator_troubleshooting.md
more sidebar labels
2023-04-19 10:31:32 -04:00
contributing.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
custom_matrix.md
Remove matrix_init_quantum/matrix_scan_quantum (#19806)
2023-02-11 03:47:17 +00:00
custom_quantum_functions.md
more sidebar labels
2023-04-19 10:31:32 -04:00
data_driven_config.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
documentation_best_practices.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
documentation_templates.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
docusaurus.config.js
try serving doxygen staticly
2023-04-20 12:15:44 -04:00
driver_installation_zadig.md
more sidebar labels
2023-04-19 10:31:32 -04:00
easy_maker.md
…
eeprom_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
faq_build.md
resolve all links, update internals
2023-04-19 15:09:25 -04:00
faq_debug.md
more sidebar labels
2023-04-19 10:31:32 -04:00
faq_general.md
more sidebar labels
2023-04-19 10:31:32 -04:00
faq_keymap.md
…
faq_misc.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_advanced_keycodes.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_audio.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_auto_shift.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_autocorrect.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_backlight.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_bluetooth.md
Normalise output selection (Bluetooth) keycodes (#19004)
2022-11-08 19:03:31 +00:00
feature_bootmagic.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_caps_word.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_combo.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_command.md
…
feature_converters.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_debounce_type.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_digitizer.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_dip_switch.md
…
feature_dynamic_macros.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_eeprom.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_encoders.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_grave_esc.md
…
feature_haptic_feedback.md
Align haptic feedback keycode names (#18964)
2022-11-07 02:43:53 +00:00
feature_hd44780.md
…
feature_joystick.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_key_lock.md
Merge remote-tracking branch 'origin/master' into develop
2022-10-24 23:28:56 -07:00
feature_key_overrides.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_layers.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_layouts.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_leader_key.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_led_indicators.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_led_matrix.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_macros.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_midi.md
Merge remote-tracking branch 'origin/master' into develop
2023-02-08 02:21:22 +00:00
feature_mouse_keys.md
add "inertia" mode for mouse keys (#18774)
2022-10-26 20:49:44 +01:00
feature_oled_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_os_detection.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_pointing_device.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_programmable_button.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_ps2_mouse.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_rawhid.md
…
feature_rgb_matrix.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_rgblight.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_secure.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_send_string.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_sequencer.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_space_cadet.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_split_keyboard.md
resolve all links, update internals
2023-04-19 15:09:25 -04:00
feature_st7565.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_stenography.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_swap_hands.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_tap_dance.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_tri_layer.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_unicode.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_userspace.md
more sidebar labels
2023-04-19 10:31:32 -04:00
feature_velocikey.md
Deprecate VLK_TOG for VK_TOGG (#18807)
2022-10-22 21:45:20 +01:00
feature_wpm.md
more sidebar labels
2023-04-19 10:31:32 -04:00
flash_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
flashing_bootloadhid.md
more sidebar labels
2023-04-19 10:31:32 -04:00
flashing.md
more sidebar labels
2023-04-19 10:31:32 -04:00
fuse.txt
…
getting_started_docker.md
…
getting_started_github.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
getting_started_introduction.md
…
getting_started_make_guide.md
more sidebar labels
2023-04-19 10:31:32 -04:00
getting_started_vagrant.md
…
gpio_control.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
hand_wire.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
hardware_drivers.md
…
hardware_keyboard_guidelines.md
resolve all links, update internals
2023-04-19 15:09:25 -04:00
how_a_matrix_works.md
…
how_keyboards_work.md
more sidebar labels
2023-04-19 10:31:32 -04:00
i2c_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
isp_flashing_guide.md
Merge branch 'master' into docusaurus
2023-04-19 15:11:12 -04:00
keycodes_basic.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
keycodes_magic.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
keycodes_us_ansi_shifted.md
more sidebar labels
2023-04-19 10:31:32 -04:00
keycodes.md
more sidebar labels
2023-04-19 10:31:32 -04:00
keymap.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
mod_tap.md
…
newbs_building_firmware_configurator.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_building_firmware_workflow.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_building_firmware.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs_flashing.md
add remaining, convert tabs
2023-04-18 16:26:49 -04:00
newbs_getting_started.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_git_best_practices.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_git_resolving_merge_conflicts.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_git_resynchronize_a_branch.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_git_using_your_master_branch.md
more sidebar labels
2023-04-19 10:31:32 -04:00
newbs_learn_more_resources.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs_testing_debugging.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs.md
resolve all links, update internals
2023-04-19 15:09:25 -04:00
one_shot_keys.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
other_eclipse.md
more sidebar labels
2023-04-19 10:31:32 -04:00
other_vscode.md
more sidebar labels
2023-04-19 10:31:32 -04:00
package-lock.json
add docsify forwarder & redirects
2023-04-19 12:59:34 -04:00
package.json
add docsify forwarder & redirects
2023-04-19 12:59:34 -04:00
platformdev_blackpill_f4x1.md
Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635)
2023-01-19 16:09:11 -07:00
platformdev_chibios_earlyinit.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
platformdev_proton_c.md
Add converter docs (#17593)
2022-07-08 22:49:16 +01:00
platformdev_rp2040.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
platformdev_selecting_arm_mcu.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
porting_your_keyboard_to_qmk.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
power.txt
…
pr_checklist.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
qmk_custom_dark.css
…
qmk_custom_light.css
…
qmk.css
…
quantum_keycodes.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
quantum_painter_lvgl.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
quantum_painter_qff.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
quantum_painter_qgf.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
quantum_painter_rle.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
quantum_painter.md
add remaining, convert tabs
2023-04-18 16:26:49 -04:00
README.md
add docsify forwarder & redirects
2023-04-19 12:59:34 -04:00
redirects.json
…
ref_functions.md
more sidebar labels
2023-04-19 10:31:32 -04:00
reference_configurator_support.md
more sidebar labels
2023-04-19 10:31:32 -04:00
reference_glossary.md
more sidebar labels
2023-04-19 10:31:32 -04:00
reference_info_json.md
more sidebar labels
2023-04-19 10:31:32 -04:00
reference_keymap_extras.md
…
serial_driver.md
resolve all links, update internals
2023-04-19 15:09:25 -04:00
sidebars.js
try serving doxygen staticly
2023-04-20 12:15:44 -04:00
spi_driver.md
…
squeezing_avr.md
Add rp2040_ce and add elite-pi and helios as alias (#19830)
2023-02-12 23:02:05 +00:00
support_deprecation_policy.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
support.md
…
sw.js
…
syllabus.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
tap_hold.md
more sidebar labels
2023-04-19 10:31:32 -04:00
translating.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
uart_driver.md
…
understanding_qmk.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
unit_testing.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
usb_nkro.txt
…
ws2812_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00

README.md

import DocsifyForwarder from '@site/src/components/DocsifyForwarder';

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

:::tip Basic

QMK Configurator
User friendly graphical interfaces, no programming knowledge required.

:::

:::caution 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.