Startseite Erkunden Hilfe
Anmelden
logic855
/
qmk_firmware
Mirror von https://github.com/qmk/qmk_firmware.git
1
0
Fork 1
Dateien Issues 0 Wiki
Branch: docusaurus
Branches Tags
qmk_firmware
/
docs
Jack Humbert 711e8b968b Merge branch 'docusaurus' of github.com:qmk/qmk_firmware into docusaurus vor 3 Jahren
..
ChangeLog e28bc93a0c Migrate other usages of `:id=...` vor 3 Jahren
gitbook bb8c5cd54a half of summary added vor 3 Jahren
ja e28bc93a0c Migrate other usages of `:id=...` vor 3 Jahren
zh-cn e28bc93a0c Migrate other usages of `:id=...` vor 3 Jahren
README.md db9f5c6013 add docsify forwarder & redirects vor 3 Jahren
adc_driver.md 272281f1a0 Add analog support for RP2040 (#19453) vor 3 Jahren
api_development_environment.md 99850aabca Add API documentation vor 6 Jahren
api_development_overview.md 99850aabca Add API documentation vor 6 Jahren
api_docs.md fff2249a7c more sidebar labels vor 3 Jahren
api_overview.md fff2249a7c more sidebar labels vor 3 Jahren
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) vor 6 Jahren
audio_driver.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
breaking_changes.md fff2249a7c more sidebar labels vor 3 Jahren
breaking_changes_history.md f5ccd04a5f Stub changelog vor 3 Jahren
breaking_changes_instructions.md fff2249a7c more sidebar labels vor 3 Jahren
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) vor 3 Jahren
cli.md fff2249a7c more sidebar labels vor 3 Jahren
cli_commands.md fff2249a7c more sidebar labels vor 3 Jahren
cli_configuration.md fff2249a7c more sidebar labels vor 3 Jahren
cli_development.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
cli_tab_complete.md fff2249a7c more sidebar labels vor 3 Jahren
coding_conventions_c.md 959f4cbb62 docs: some typos (#18582) vor 4 Jahren
coding_conventions_python.md fc5eb10822 resolve all links, update internals vor 3 Jahren
compatible_microcontrollers.md ac5e6b6a3b Tentative Teensy 3.5 support (#14420) vor 4 Jahren
config_options.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
configurator_architecture.md fff2249a7c more sidebar labels vor 3 Jahren
configurator_default_keymaps.md fff2249a7c more sidebar labels vor 3 Jahren
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) vor 5 Jahren
configurator_step_by_step.md fff2249a7c more sidebar labels vor 3 Jahren
configurator_troubleshooting.md fff2249a7c more sidebar labels vor 3 Jahren
contributing.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) vor 3 Jahren
custom_quantum_functions.md fff2249a7c more sidebar labels vor 3 Jahren
data_driven_config.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
documentation_best_practices.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
documentation_templates.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
driver_installation_zadig.md fff2249a7c more sidebar labels vor 3 Jahren
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) vor 4 Jahren
eeprom_driver.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
faq_build.md fc5eb10822 resolve all links, update internals vor 3 Jahren
faq_debug.md fff2249a7c more sidebar labels vor 3 Jahren
faq_general.md fff2249a7c more sidebar labels vor 3 Jahren
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) vor 4 Jahren
faq_misc.md fff2249a7c more sidebar labels vor 3 Jahren
feature_advanced_keycodes.md 6d53f61608 Merge remote-tracking branch 'upstream/master' into docusaurus vor 3 Jahren
feature_audio.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_auto_shift.md fff2249a7c more sidebar labels vor 3 Jahren
feature_autocorrect.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_backlight.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_bluetooth.md d810878d5e Normalise output selection (Bluetooth) keycodes (#19004) vor 3 Jahren
feature_bootmagic.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_caps_word.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_combo.md 6d53f61608 Merge remote-tracking branch 'upstream/master' into docusaurus vor 3 Jahren
feature_command.md a03aa301de Remove Full Bootmagic (#13846) vor 5 Jahren
feature_converters.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_debounce_type.md fff2249a7c more sidebar labels vor 3 Jahren
feature_digitizer.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) vor 5 Jahren
feature_dynamic_macros.md fff2249a7c more sidebar labels vor 3 Jahren
feature_eeprom.md fff2249a7c more sidebar labels vor 3 Jahren
feature_encoders.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) vor 4 Jahren
feature_haptic_feedback.md e4d2ba9a4d Align haptic feedback keycode names (#18964) vor 3 Jahren
feature_hd44780.md 9ee2effe8e HD44780 driver rework (#16370) vor 4 Jahren
feature_joystick.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop vor 3 Jahren
feature_key_overrides.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_layers.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_layouts.md fff2249a7c more sidebar labels vor 3 Jahren
feature_leader_key.md fff2249a7c more sidebar labels vor 3 Jahren
feature_led_indicators.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_led_matrix.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_macros.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop vor 3 Jahren
feature_mouse_keys.md 2a61bfc27d add "inertia" mode for mouse keys (#18774) vor 3 Jahren
feature_oled_driver.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_os_detection.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_pointing_device.md 6d53f61608 Merge remote-tracking branch 'upstream/master' into docusaurus vor 3 Jahren
feature_programmable_button.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_ps2_mouse.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_rawhid.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
feature_rgb_matrix.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_rgblight.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_secure.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_send_string.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_sequencer.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_space_cadet.md fff2249a7c more sidebar labels vor 3 Jahren
feature_split_keyboard.md fc5eb10822 resolve all links, update internals vor 3 Jahren
feature_st7565.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_stenography.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_swap_hands.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_tap_dance.md fff2249a7c more sidebar labels vor 3 Jahren
feature_tri_layer.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_unicode.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
feature_userspace.md fff2249a7c more sidebar labels vor 3 Jahren
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) vor 3 Jahren
feature_wpm.md fff2249a7c more sidebar labels vor 3 Jahren
flash_driver.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
flashing.md fff2249a7c more sidebar labels vor 3 Jahren
flashing_bootloadhid.md fff2249a7c more sidebar labels vor 3 Jahren
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) vor 5 Jahren
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
getting_started_github.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) vor 6 Jahren
getting_started_make_guide.md fff2249a7c more sidebar labels vor 3 Jahren
getting_started_vagrant.md b56282756b [Docs] Clean up some code block languages (#14434) vor 5 Jahren
gpio_control.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
hand_wire.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) vor 5 Jahren
hardware_keyboard_guidelines.md fc5eb10822 resolve all links, update internals vor 3 Jahren
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) vor 5 Jahren
how_keyboards_work.md fff2249a7c more sidebar labels vor 3 Jahren
i2c_driver.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
isp_flashing_guide.md 7ce0874617 Merge branch 'master' into docusaurus vor 3 Jahren
keycodes.md fff2249a7c more sidebar labels vor 3 Jahren
keycodes_basic.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
keycodes_magic.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
keycodes_us_ansi_shifted.md fff2249a7c more sidebar labels vor 3 Jahren
keymap.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
mod_tap.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) vor 4 Jahren
newbs.md fc5eb10822 resolve all links, update internals vor 3 Jahren
newbs_building_firmware.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
newbs_building_firmware_configurator.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_building_firmware_workflow.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_flashing.md 40a4ee5114 add remaining, convert tabs vor 3 Jahren
newbs_getting_started.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_git_best_practices.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_git_resolving_merge_conflicts.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_git_resynchronize_a_branch.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_git_using_your_master_branch.md fff2249a7c more sidebar labels vor 3 Jahren
newbs_learn_more_resources.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
newbs_testing_debugging.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
one_shot_keys.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
other_eclipse.md fff2249a7c more sidebar labels vor 3 Jahren
other_vscode.md fff2249a7c more sidebar labels vor 3 Jahren
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) vor 3 Jahren
platformdev_chibios_earlyinit.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) vor 4 Jahren
platformdev_rp2040.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
platformdev_selecting_arm_mcu.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
porting_your_keyboard_to_qmk.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
power.txt bb53635f33 Trim trailing whitespace vor 8 Jahren
pr_checklist.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
qmk.css ccc87421e7 Some more tweaks to make everything look nice vor 8 Jahren
qmk_custom_dark.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) vor 5 Jahren
quantum_keycodes.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
quantum_painter.md 40a4ee5114 add remaining, convert tabs vor 3 Jahren
quantum_painter_lvgl.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
quantum_painter_qff.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
quantum_painter_qgf.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
quantum_painter_rle.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
redirects.json d569f08771 Configuration system for CLI (#6708) vor 7 Jahren
ref_functions.md fff2249a7c more sidebar labels vor 3 Jahren
reference_configurator_support.md fff2249a7c more sidebar labels vor 3 Jahren
reference_glossary.md fff2249a7c more sidebar labels vor 3 Jahren
reference_info_json.md fff2249a7c more sidebar labels vor 3 Jahren
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) vor 4 Jahren
serial_driver.md fc5eb10822 resolve all links, update internals vor 3 Jahren
spi_driver.md 0e59827023 Merge remote-tracking branch 'upstream/master' into develop vor 5 Jahren
squeezing_avr.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) vor 3 Jahren
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) vor 6 Jahren
support_deprecation_policy.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
sw.js 303f425c6b Fix up info boxes. vor 8 Jahren
syllabus.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
tap_hold.md fff2249a7c more sidebar labels vor 3 Jahren
translating.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
uart_driver.md 04b51e381e Update UART driver API (#14839) vor 4 Jahren
understanding_qmk.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
unit_testing.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores vor 9 Jahren
ws2812_driver.md 2cef3465e8 add docusaurus, convert notes/tips, ids vor 3 Jahren

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](newbs_building_firmware_configurator.md)
User friendly graphical interfaces, no programming knowledge required. ::: :::caution Advanced [Use The Source](newbs.md)
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.