首頁 探索 說明
登入
logic855
/
qmk_firmware
镜像来自 https://github.com/qmk/qmk_firmware.git
1
0
複刻 1
Files 問題管理 0 Wiki
目錄樹: ca9664b1ac
分支列表 標籤列表
qmk_firmware
/
docs
Yanfei Guo 17ae28f0e4 Fix doc for programmable buttons. (#22136) 2 年之前
..
ChangeLog 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 年之前
gitbook 4580d3a730 RGB improvements (#1684) 9 年之前
internals 75544d9127 Move Doxygen docs to subdirectory (#16561) 4 年之前
ja ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 3 年之前
zh-cn 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 3 年之前
.nojekyll 9e5676650e Use docsfy to replace gitbook 8 年之前
CNAME 4d26137e2a Create CNAME 8 年之前
README.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 年之前
_langs.md 1c1e6fa47d Remove stale docs translations (#15737) 4 年之前
_summary.md 39fafdac0f Move Digitizer to "Software Features" (#22031) 2 年之前
adc_driver.md 272281f1a0 Add analog support for RP2040 (#19453) 3 年之前
api_development_environment.md 99850aabca Add API documentation 6 年之前
api_development_overview.md 99850aabca Add API documentation 6 年之前
api_docs.md 9e78e65a56 2022 Nov 26 changelog. (#19164) 3 年之前
api_overview.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年之前
arm_debugging.md 52c18ef026 [Docs] fix docs (#7642) 6 年之前
audio_driver.md 19145704e4 [Core] Adjust PWM hardware audio driver for RP2040 (#17723) 3 年之前
breaking_changes.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 年之前
breaking_changes_history.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 年之前
breaking_changes_instructions.md 32d865572c `develop` 2023q2 changelog (#21049) 3 年之前
chibios_upgrade_instructions.md 7ebb8c2dec Update branch names to reflect configurator's new deployment. (#19999) 3 年之前
cli.md fcf150bd82 Streamline the macos install process 6 年之前
cli_commands.md 102c42b14b `qmk find`: usability improvements (#20440) 3 年之前
cli_configuration.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 年之前
cli_development.md 959f4cbb62 docs: some typos (#18582) 3 年之前
cli_tab_complete.md ee26d3e77f Add Zsh note for tab complete (#17226) 4 年之前
coding_conventions_c.md 2f1cac6e9f [Docs] Code markdown amendment (#21323) 3 年之前
coding_conventions_python.md 959f4cbb62 docs: some typos (#18582) 3 年之前
compatible_microcontrollers.md c814be0296 STM32H723 support (#21352) 3 年之前
config_options.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 3 年之前
configurator_architecture.md 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 年之前
configurator_default_keymaps.md 961f0b7b2d Reallocate SAFE_RANGE (#19909) 3 年之前
configurator_diagram.drawio 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 年之前
configurator_diagram.svg 9a0118c603 Architecture documentation for Configurator and API (#13935) 5 年之前
configurator_step_by_step.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 年之前
configurator_troubleshooting.md d5f34c4810 Polish Configurator section 6 年之前
contributing.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 年之前
custom_matrix.md 11d49d00e7 Remove matrix_init_quantum/matrix_scan_quantum (#19806) 3 年之前
custom_quantum_functions.md 012fa6dd45 [Doc] Add example to keyboard housekeeping and some minor fixes (#19968) 3 年之前
data_driven_config.md ffdc70bf0a Consolidate `KEYBOARD_OUTPUT`+`KEYMAP_OUTPUT`=>`INTERMEDIATE_OUTPUT` (#21272) 3 年之前
documentation_best_practices.md 995464cb9c [Docs] fix file path (#9540) 6 年之前
documentation_templates.md b756c53c7b [Docs] Touch up documentation templates & porting keyboard docs (#19573) 3 年之前
driver_installation_zadig.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 4 年之前
easy_maker.md f6a7f4d4ac update the Chinese translation based on the latest English version (#14924) 4 年之前
eeprom_driver.md 5846b40f74 RP2040 emulated EEPROM. (#17519) 4 年之前
faq_build.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年之前
faq_debug.md 18dc851e37 Remove legacy Debug keycode (#18769) 3 年之前
faq_general.md d6701b3ac7 Fix typos and reword some sentences in FAQs (#11546) 5 年之前
faq_keymap.md d241e80533 Keymap FAQ updates (#17130) 4 年之前
faq_misc.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 4 年之前
feature_advanced_keycodes.md e1afcda1c0 Update code example to match description (#20528) 3 年之前
feature_audio.md 69fa02c37d Align audio keycode names (#18962) 3 年之前
feature_auto_shift.md e9ff66d8ad Adds a way to separate tab from AUTO_SHIFT_SPECIAL. (#20996) 3 年之前
feature_autocorrect.md 55295ed3dc [Enhancement] More info on `apply_autocorrect` (#21056) 3 年之前
feature_backlight.md 4137685f8e backlight: split AVR PWM and timer drivers (#21540) 3 年之前
feature_bluetooth.md b4a7b9253a Bluetooth: driver naming cleanups (#21624) 3 年之前
feature_bootmagic.md 9aaf4a5a9b Add split keyboard example for Bootmagic Lite (#16349) 4 年之前
feature_caps_word.md ae63c0f509 [Core] Caps Word "Invert on shift" option: pressing Shift inverts the shift state. (#20092) 3 年之前
feature_combo.md 5faa23d54c Keymap introspection for combos. (#19670) 3 年之前
feature_command.md a03aa301de Remove Full Bootmagic (#13846) 5 年之前
feature_converters.md dbfbf6c2c4 Merge remote-tracking branch 'origin/master' into develop 3 年之前
feature_debounce_type.md f56cf93fa1 Add debounce time description (#20333) 3 年之前
feature_digitizer.md 6cc9513ab0 Digitizer feature improvements (#19034) 3 年之前
feature_dip_switch.md 9d1c98c891 Added right vs left specific pin assignments for dip switch (#13074) 5 年之前
feature_dynamic_macros.md 68efea70b2 Add direction to dynamic_macro_record_start_user (#19689) 3 年之前
feature_eeprom.md 7407347be1 Remove rgblight_list.h (#18878) 3 年之前
feature_encoders.md c9f619124d Encodermap direction define. (#20454) 3 年之前
feature_grave_esc.md b45a037c7e Rename some Quantum keycodes (#15968) 4 年之前
feature_haptic_feedback.md 0b802defd4 haptic: further naming cleanups (#21682) 3 年之前
feature_hd44780.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 年之前
feature_joystick.md 917d93e968 [Docs] Fix `JOYSTICK_AXIS_COUNT` name in docs (#19605) 3 年之前
feature_key_lock.md eeb3f9c043 Merge remote-tracking branch 'origin/master' into develop 3 年之前
feature_key_overrides.md 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 3 年之前
feature_layers.md b9c4bd0d66 Changed interverts to inverts (#21270) 3 年之前
feature_layouts.md b56282756b [Docs] Clean up some code block languages (#14434) 5 年之前
feature_leader_key.md bbf7a20b33 Refactor Leader key feature (#19632) 3 年之前
feature_led_indicators.md 1124bbc1db Remove deprecated led_set_kb (#19273) 3 年之前
feature_led_matrix.md dfb6d38f08 Simplfy RGB/LED matrix effect logic (#21703) 3 年之前
feature_macros.md f07490bc09 Corrected duration example, should be number not string (#21839) 3 年之前
feature_midi.md 650864c27d Merge remote-tracking branch 'origin/master' into develop 3 年之前
feature_mouse_keys.md a05e5b5554 Add MOUSEKEY_WHEEL_DELTA documentation (#21493) 3 年之前
feature_oled_driver.md 6eb2e43a8d Fix typo in oled_driver (#22134) 2 年之前
feature_os_detection.md 85ee55ff3b Detect host OS based on USB fingerprint (#18463) 3 年之前
feature_pointing_device.md 59eb8940b0 Make Pointing Device Auto Layer more configurable (#20061) 3 年之前
feature_programmable_button.md 17ae28f0e4 Fix doc for programmable buttons. (#22136) 2 年之前
feature_ps2_mouse.md 4d994458f0 Document the RP2040-specific PS/2 implementation (#22079) 2 年之前
feature_rawhid.md 8b7ac7f2ca Raw HID: documentation improvements (#21596) 3 年之前
feature_repeat_key.md 3993b15f05 [Core] Add Repeat Key ("repeat last key") as a core feature. (#19700) 3 年之前
feature_rgb_matrix.md 37bc949945 RGB Matrix: driver naming cleanups (#21594) 3 年之前
feature_rgblight.md 9b429bd12d Revert "Update feature_rgblight.md" (#22132) 2 年之前
feature_secure.md ec2414c074 Deprecate `SECURE_*` keycodes for `QK_SECURE_*` (#18847) 3 年之前
feature_send_string.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 年之前
feature_sequencer.md f587a0c548 Align sequencer keycodes (#19875) 3 年之前
feature_space_cadet.md 725c9f3c85 Use wayback machine for unreachable site (#20987) 3 年之前
feature_split_keyboard.md a518e1e5d8 Sync activity timestamps between sides. (#20192) 3 年之前
feature_st7565.md 37fba09021 ST7565 invert (#13237) 5 年之前
feature_stenography.md fcf8b804ed [Core] Refactor `keyevent_t` for 1ms timing resolution (#15847) 3 年之前
feature_swap_hands.md f5b7491883 Add swap hands toggle functions (#20381) 3 年之前
feature_tap_dance.md 2c70d38910 On-each-release tap dance function (#20255) 3 年之前
feature_tri_layer.md fe02abc479 [Core] Tri Layer Keys (#19795) 3 年之前
feature_unicode.md 70e34e491c Unicode, Unicodemap and UCIS refactor (#21659) 3 年之前
feature_userspace.md 40bc5a8192 Enable CLI flashing via mdloader (#14729) 4 年之前
feature_velocikey.md 74484e21af Deprecate `VLK_TOG` for `VK_TOGG` (#18807) 3 年之前
feature_wpm.md 990ee8075e Fix typo in `feature_wpm.md` title (#20464) 3 年之前
flash_driver.md 71c0b97bce Added external spi flash driver. (#15419) 4 年之前
flashing.md a0ea7a6b17 feat, docs: WB32 flashing (#21217) 3 年之前
flashing_bootloadhid.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 4 年之前
fuse.txt 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 年之前
getting_started_docker.md b56282756b [Docs] Clean up some code block languages (#14434) 5 年之前
getting_started_github.md b2a186cf92 Purge uGFX. (#14720) 4 年之前
getting_started_introduction.md 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 6 年之前
getting_started_make_guide.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 3 年之前
gpio_control.md cf935d97ae Fix functions with empty params (#19647) 3 年之前
hand_wire.md fc7e9efd21 Improve importer workflow (#17707) 4 年之前
hardware_drivers.md b2a186cf92 Purge uGFX. (#14720) 4 年之前
hardware_keyboard_guidelines.md 4704a4e053 Merge remote-tracking branch 'origin/master' into develop 3 年之前
how_a_matrix_works.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年之前
how_keyboards_work.md b85c224b7c docs: reflect systemd's change in language (#17322) 4 年之前
i2c_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 年之前
index.html 94755308e0 Fix anchors with <code> in table of content (#15169) 4 年之前
isp_flashing_guide.md 952cdc7be5 Adds Docs option for ArduinoIDE's example `ArduinoISP` (#20486) 3 年之前
keycodes.md a4ed6ad0f5 Unicodemap keycodes rename (#21092) 3 年之前
keycodes_basic.md 0152dd811d Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 3 年之前
keycodes_magic.md 403b0addea Align magic keycodes (#19877) 3 年之前
keycodes_us_ansi_shifted.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 年之前
keymap.md 95671148a4 [Docs] Change defines to enums in examples (#19793) 3 年之前
mod_tap.md 1899793f27 Make IGNORE_MOD_TAP_INTERRUPT the default behaviour for mod-taps (#20211) 3 年之前
newbs.md 92a787ca4c [Docs] Use HTTPS for images and links where possible (#11695) 5 年之前
newbs_building_firmware.md 32dabd5320 Align new-keymap with new-keyboard (#19229) 3 年之前
newbs_building_firmware_configurator.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 年之前
newbs_building_firmware_workflow.md 43ce7b0df5 [Docs] Highlight keymap name entry (#21138) 3 年之前
newbs_flashing.md f35cb924e9 Update newbs docs with some rp2040 stuff (#21186) 3 年之前
newbs_getting_started.md 4c6c387724 Add an emphasis on QMK MSYS terminal (#21168) 3 年之前
newbs_git_best_practices.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 年之前
newbs_git_resolving_merge_conflicts.md 3152bf572b [Docs] Restructure of Git Best Practices doc (#7231) 6 年之前
newbs_git_resynchronize_a_branch.md f667821ed3 [Docs] Resynchronizing Your Branch including submodules (#19268) 3 年之前
newbs_git_using_your_master_branch.md 54c58ea6de Add explicit id tags to externally linked headers 6 年之前
newbs_learn_more_resources.md 70c6b183df [Docs] Refactor code examples (#18003) 4 年之前
newbs_testing_debugging.md 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 年之前
one_shot_keys.md 9ddb0165a4 fix typo (#19189) 3 年之前
other_eclipse.md 14f886d03b [Docs] Address some typos (also in moonlander matrix.c) (#16248) 4 年之前
other_vscode.md 1ca34c2168 Fix VS code live share extension link (#21585) 3 年之前
platformdev_blackpill_f4x1.md e5b36e2c3f Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 3 年之前
platformdev_chibios_earlyinit.md 01f31bf28e [Docs] RESET -> QK_BOOT (#18365) 4 年之前
platformdev_proton_c.md 345e19f691 Add converter docs (#17593) 4 年之前
platformdev_rp2040.md 896d9aa98c Add rp2040_ce and add elite-pi and helios as alias (#19830) 3 年之前
platformdev_selecting_arm_mcu.md 3afd2d81b8 Add documentation for selecting an Arm MCU (#9046) 6 年之前
porting_your_keyboard_to_qmk.md f067f42305 [Docs] Discuss layout macro (#19803) 3 年之前
power.txt bb53635f33 Trim trailing whitespace 8 年之前
pr_checklist.md bd2a33fe77 Add reminder about format-json to PR Checklist (#22055) 2 年之前
qmk.css ccc87421e7 Some more tweaks to make everything look nice 8 年之前
qmk_custom_dark.css e3c6467ab9 [Docs] Improve contrast for warnings in dark mode (#21928) 3 年之前
qmk_custom_light.css 4e8166750b Small tweaks to docs to make them more user friendly (#11518) 5 年之前
quantum_keycodes.md 7bd1d18427 [Docs] Add note about `ENABLE_COMPILE_KEYCODE` to docs (#21290) 3 年之前
quantum_painter.md 26227d1f66 [Docs] Fix listed defaults in quantum painter docs (#21429) 3 年之前
quantum_painter_lvgl.md cf935d97ae Fix functions with empty params (#19647) 3 年之前
quantum_painter_qff.md 1f2b1dedcc Quantum Painter (#10174) 4 年之前
quantum_painter_qgf.md 1f2b1dedcc Quantum Painter (#10174) 4 年之前
quantum_painter_rle.md 1f2b1dedcc Quantum Painter (#10174) 4 年之前
redirects.json d569f08771 Configuration system for CLI (#6708) 7 年之前
ref_functions.md c347e732be Remove legacy EEPROM clear keycodes (#18782) 3 年之前
reference_configurator_support.md f529580860 Basic keycode overhaul (#14726) 4 年之前
reference_glossary.md 4818e14c77 Breaking changes changelog, 2023q3 version (#21848) 3 年之前
reference_info_json.md 736451558e Rework info.json reference (#21324) 3 年之前
reference_keymap_extras.md 4a8bd7b9a5 Rename keymap_extras headers for consistency (#16939) 4 年之前
serial_driver.md 3f45fd4924 Fix serial_driver.md list item numbering (#19819) 3 年之前
spi_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 年之前
squeezing_avr.md c2b837514b [Doc] Improve magic keycode section (#21787) 3 年之前
support.md e4823aadec Fix capitalisation of "GitHub" (#9184) 6 年之前
support_deprecation_policy.md d1a430b348 Initial deprecation policy documentation. (#19908) 3 年之前
sw.js 303f425c6b Fix up info boxes. 8 年之前
syllabus.md f4966a19d6 [Docs] Squeezing space out of AVR (#15243) 4 年之前
tap_hold.md 1abf8f3e8b [Feature] Send a dummy keycode to neutralize flashing modifiers in retro tap and key overrides (#20992) 3 年之前
translating.md 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 6 年之前
uart_driver.md 12edfc0c69 Fix anchor IDs for some API references (#21345) 3 年之前
understanding_qmk.md 21b660fa07 Move `pre_process_record_kb()` before `process_combo()` (#20969) 3 年之前
unit_testing.md 1c0347b8b8 Remove SERIAL_LINK feature (#14727) 4 年之前
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 9 年之前
ws2812_driver.md 47966dc2a6 Migrate `rgblight.pin` and `RGB_DI_PIN` to `ws2812.pin` (#20303) 3 年之前

README.md

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

?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md)
User friendly graphical interfaces, no programming knowledge required. ?> **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.