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

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.