qmk/qmk_firmware
1
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2026-09-07 10:53:17 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
29f2e9f19a89fdf76ebeb575c13dc5781b9cc16d
qmk_firmware/docs
T
History
Jack Humbert 29f2e9f19a update github workflow for docusaurus
2023-04-18 19:50:04 -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
internals
Move Doxygen docs to subdirectory (#16561)
2022-03-07 11:22:22 +00:00
ja
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
src
half of summary added
2023-04-18 13:44:25 -04:00
static
half of summary added
2023-04-18 13:44:25 -04:00
zh-cn
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
_langs.md
Remove stale docs translations (#15737)
2022-01-04 18:11:24 -08: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
.nojekyll
Use docsfy to replace gitbook
2018-05-07 22:46:26 -07:00
adc_driver.md
Add analog support for RP2040 (#19453)
2023-01-19 10:30:58 +11:00
api_development_environment.md
Add API documentation
2020-03-05 16:00:10 -08:00
api_development_overview.md
Add API documentation
2020-03-05 16:00:10 -08:00
api_docs.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
api_overview.md
[Docs] Use HTTPS for images and links where possible (#11695)
2021-01-30 22:00:56 +11:00
arm_debugging.md
[Docs] fix docs (#7642)
2019-12-21 11:00:22 +00:00
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
2020 May 30 Breaking Changes Update (#9215)
2020-05-30 13:14:59 -07:00
breaking_changes.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
Add qmk find command, reuse logic for qmk mass-compile. (#20139)
2023-03-16 20:35:49 +00:00
cli_configuration.md
Fix capitalisation of "GitHub" (#9184)
2020-05-25 19:43:14 -07:00
cli_development.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
cli_tab_complete.md
Add Zsh note for tab complete (#17226)
2022-07-02 21:59:59 +10:00
cli.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
CNAME
Create CNAME
2018-05-21 16:29:37 -04:00
coding_conventions_c.md
docs: some typos (#18582)
2022-10-05 17:32:07 +01:00
coding_conventions_python.md
docs: some typos (#18582)
2022-10-05 17:32:07 +01: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
Architecture documentation for Configurator and API (#13935)
2021-08-10 07:47:53 -07:00
configurator_default_keymaps.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
configurator_diagram.drawio
Architecture documentation for Configurator and API (#13935)
2021-08-10 07:47:53 -07:00
configurator_diagram.svg
Architecture documentation for Configurator and API (#13935)
2021-08-10 07:47:53 -07:00
configurator_step_by_step.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
configurator_troubleshooting.md
Polish Configurator section
2020-03-05 16:00:10 -08: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
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
half of summary added
2023-04-18 13:44:25 -04:00
driver_installation_zadig.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
easy_maker.md
update the Chinese translation based on the latest English version (#14924)
2022-01-18 18:24:02 +00:00
eeprom_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
faq_build.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
faq_debug.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
faq_general.md
Fix typos and reword some sentences in FAQs (#11546)
2021-01-23 13:41:29 -08:00
faq_keymap.md
Keymap FAQ updates (#17130)
2022-05-18 04:48:59 +10:00
faq_misc.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
Remove Full Bootmagic (#13846)
2021-08-06 23:59:56 -07:00
feature_converters.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_debounce_type.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_digitizer.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_dip_switch.md
Added right vs left specific pin assignments for dip switch (#13074)
2021-08-19 18:39:15 +01:00
feature_dynamic_macros.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_eeprom.md
Remove rgblight_list.h (#18878)
2022-10-27 23:50:14 +01:00
feature_encoders.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_grave_esc.md
Rename some Quantum keycodes (#15968)
2022-01-22 03:34:15 +00:00
feature_haptic_feedback.md
Align haptic feedback keycode names (#18964)
2022-11-07 02:43:53 +00:00
feature_hd44780.md
HD44780 driver rework (#16370)
2022-03-19 17:57:22 +11:00
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
[Docs] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
feature_leader_key.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
[Docs] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
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
Normalise Space Cadet keycodes (#18864)
2022-10-27 11:19:16 +01:00
feature_split_keyboard.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
feature_velocikey.md
Deprecate VLK_TOG for VK_TOGG (#18807)
2022-10-22 21:45:20 +01:00
feature_wpm.md
Fix typo in feature_wpm.md title (#20464)
2023-04-16 15:14:08 +01:00
flash_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
flashing_bootloadhid.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
flashing.md
Add f303 to tinyuf2 bootloader support (#19620)
2023-01-18 22:36:58 +00:00
fuse.txt
Ensure single newline at EOF for core files (#11310)
2020-12-28 04:36:32 +11:00
getting_started_docker.md
[Docs] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
getting_started_github.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
getting_started_introduction.md
[Docs] update git command and directory name of documents (#7619)
2019-12-12 20:59:00 -08:00
getting_started_make_guide.md
Add support for deferred executors. (#14859)
2021-11-15 18:21:09 +00:00
getting_started_vagrant.md
[Docs] Clean up some code block languages (#14434)
2021-09-14 13:16:24 +01:00
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
Purge uGFX. (#14720)
2021-10-07 10:57:48 +11:00
hardware_keyboard_guidelines.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
how_a_matrix_works.md
[Docs] Use HTTPS for images and links where possible (#11695)
2021-01-30 22:00:56 +11:00
how_keyboards_work.md
docs: reflect systemd's change in language (#17322)
2022-06-06 23:29:59 +01:00
i2c_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
index.html
Fix anchors with <code> in table of content (#15169)
2022-05-14 23:08:32 +01:00
isp_flashing_guide.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
2022-02-06 17:36:44 +00:00
keycodes.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
keymap.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
mod_tap.md
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
2022-02-06 17:36:44 +00:00
newbs_building_firmware_configurator.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs_building_firmware_workflow.md
add remaining, convert tabs
2023-04-18 16:26:49 -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
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs_git_best_practices.md
[Docs] Restructure of Git Best Practices doc (#7231)
2019-12-02 18:47:02 -08:00
newbs_git_resolving_merge_conflicts.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs_git_resynchronize_a_branch.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
newbs_git_using_your_master_branch.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -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
half of summary added
2023-04-18 13:44:25 -04:00
one_shot_keys.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
other_eclipse.md
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
2022-02-06 17:36:44 +00:00
other_vscode.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
package-lock.json
update github workflow for docusaurus
2023-04-18 19:50:04 -04:00
package.json
update github workflow for docusaurus
2023-04-18 19:50:04 -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
Trim trailing whitespace
2017-12-09 10:46:11 -05:00
pr_checklist.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
qmk_custom_dark.css
Small tweaks to docs to make them more user friendly (#11518)
2021-01-20 18:46:01 +00:00
qmk_custom_light.css
Small tweaks to docs to make them more user friendly (#11518)
2021-01-20 18:46:01 +00:00
qmk.css
Some more tweaks to make everything look nice
2018-05-07 23:42:41 -07:00
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 remaining, convert tabs
2023-04-18 16:26:49 -04:00
redirects.json
Configuration system for CLI (#6708)
2019-09-22 13:25:33 -07:00
ref_functions.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
reference_configurator_support.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
reference_glossary.md
Fix Space Cadet md link (#14300)
2021-09-04 15:01:56 +01:00
reference_info_json.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
reference_keymap_extras.md
Rename keymap_extras headers for consistency (#16939)
2022-05-15 21:27:01 +10:00
serial_driver.md
add remaining, convert tabs
2023-04-18 16:26:49 -04:00
sidebars.js
autogen internals list
2023-04-18 17:22:06 -04:00
spi_driver.md
Merge remote-tracking branch 'upstream/master' into develop
2021-02-08 07:57:09 +11:00
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
Fix capitalisation of "GitHub" (#9184)
2020-05-25 19:43:14 -07:00
sw.js
Fix up info boxes.
2018-05-07 22:46:26 -07:00
syllabus.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
tap_hold.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
translating.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00
uart_driver.md
Update UART driver API (#14839)
2021-11-13 18:23:14 +00:00
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
convert docs to lowercase and underscores
2017-06-10 14:58:55 -04:00
ws2812_driver.md
add docusaurus, convert notes/tips, ids
2023-04-18 12:35:09 -04:00

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

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

Reference in New Issue View Git Blame Copy Permalink