summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Update one_shot_keys.md (#10917)j-zero2020-11-181-1/+1
| | | MOD_RSFT doesn't work. See: https://github.com/qmk/qmk_firmware/issues/10901
* Recommend use of LED Indicator config (#10895)Joel Challis2020-11-161-0/+1
| | | | | | | | | | | * Recommend use of LED Indicator config * Recommend use of LED Indicator config - update link * Update quantum/template/ps2avrgb/config.h Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* CI: Add docs build and deploy workflow (#7448)Joel Challis2020-11-101-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add docs build and deploy workflow * Remove old travis docs workflow * update to cli command * Tidy up for review * formatting * Update to pass style checks * Update lib/python/qmk/cli/docs.py Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Review comments - build->generate, use of verbose * Add docs * Update to match recent actions * Run within base_container * Convert cli to generate-docs * Convert cli to generate-docs - restore old file * Convert cli to generate-docs * Update docs Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
* Added color wheel that have QMK HSV values. (#8997)elijahblake812020-11-101-0/+2
| | | I've converted the 360 color wheel to the 255 color wheel for QMK HSV values.
* [Docs] redirect from /tutorial to /newbs (#10718)Mikkel Jeppesen2020-11-092-1/+2
| | | | | | | * Added redirect from /tutorial to /newbs * Fixed indentation * Changed title of tutorial page
* Adding few Korean translated files (#5895)SeungheonOh2020-11-104-0/+273
| | | | | | | | | * Korean Translation Korean Translation * Korean translation * more Korean translations
* Indicator LEDs as config (#10816)Joel Challis2020-11-083-102/+117
| | | | | | | | | | | | | | | * First pass * Add config options to docs * Update some wording * Slight tidy up of backlight caps logic * Init pin to correct state * Move init location * Reverse default state
* New command: qmk lint (#10761)Zach White2020-11-072-1/+37
| | | | | | | | | | | | | | | | | | | | | | | | | * Basic qmk lint command * check for keymap readme * change the workflow from qmk info to qmk lint * add a strict mode * parsing -> parse * document qmk lint * small info logging cleanup * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * honor --strict in more places * change the job name to lint Co-authored-by: Ryan <fauxpark@gmail.com>
* CLI: Add `qmk clean` (#10785)Ryan2020-11-041-0/+10
|
* Add brightness level API to OLED driver (#10772)Ryan2020-10-291-2/+9
| | | | | * Add brightness level API to OLED driver * Set default brightness to 255
* Add last breaking changes log to sidebar (#10680)Drashna Jaelre2020-10-182-0/+2
| | | Co-authored-by: Ryan <fauxpark@gmail.com>
* 50-qmk.rules: Move udev rules from documentation into a file (#10664)Morten Linderud2020-10-171-65/+1
| | | | | | This makes it overall easier to package for downstream distributions instead of keeping tabs with inline documentation. Signed-off-by: Morten Linderud <morten@linderud.pw>
* [Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049)James Young2020-10-182-0/+194
|
* MSYS and WSL installation improvements (#10593)Ryan2020-10-181-1/+1
|
* [Docs] Update feature_combo.md of Japanese document (#10671)shela2020-10-171-3/+3
|
* [Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548)Andre Azzolini2020-10-151-0/+4
|
* Update other_vscode.md of Japanese document (#10604)shela2020-10-152-9/+9
| | | | | | | | | | | * Update Japanese document * Fix inline code * Update docs/ja/other_vscode.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Update Japanese document (#10607)shela2020-10-141-11/+12
|
* [Docs] Japanese translation of docs/pr_checklist.md (#10415)Takeshi ISHII2020-10-143-2/+136
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * japanese translation of docs/pr_checklist.md * update docs/ja/pr_checklist.md * update docs/ja/pr_checklist.md * update docs/ja/pr_checklist.md * add :id=lite to docs/ja/custom_matrix.md * add :id=... to docs/ja/custom_quantum_functions.md * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md * Update docs/ja/pr_checklist.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/pr_checklist.md Co-authored-by: s-show <s1shimz@gmail.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com>
* Update tags to check for document updates (#10606)shela2020-10-1310-20/+20
|
* Fix typo within debounce documentation (#10600)shela2020-10-131-2/+2
|
* Update Japanese document (#10605)shela2020-10-131-3/+5
|
* Update Japanese document (#10601)shela2020-10-131-2/+3
|
* Update Japanese document. (#10599)shela2020-10-131-5/+7
|
* Update feature_bluetooth.md of Japanese document. (#10594)shela2020-10-131-11/+14
| | | | | | | | | | | | | | | | * Update Japanese document. * Left justified. * Update docs/ja/feature_bluetooth.md Co-authored-by: s-show <s1shimz@gmail.com> * Update docs/ja/feature_bluetooth.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: s-show <s1shimz@gmail.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Update Japanese document. (#10589)shela2020-10-131-80/+69
|
* Update Japanese document (#10603)shela2020-10-131-4/+4
|
* [Docs] Japanese translation of docs/isp_flashing_guide.md (#9896)Takeshi ISHII2020-10-131-0/+284
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * start translation docs/ja/isp_flashing_guide.md * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * Japanese translation is in progress. * update docs/ja/isp_flashing_guide.md * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md * Update docs/ja/isp_flashing_guide.md Co-authored-by: shela <shelaf@users.noreply.github.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> * Update docs/ja/isp_flashing_guide.md Co-authored-by: Takuya Urakawa <urkwtky@gmail.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>
* changed type of process_combo_event argument in tutorial (#10621)Jan-Frederick Musiol2020-10-131-1/+1
| | | in tutorial for combos feature, changed type of compo_index argument of process_combo_event form uint8_t to uint16_t
* Update feature_backlight.md of Japanese document. (#10592)shela2020-10-101-4/+2
| | | | | * Update Japanese document. * Update tag
* Update Japanese document. (#10591)shela2020-10-101-3/+3
|
* Update Japanese document. (#10590)shela2020-10-101-16/+2
|
* Update Japanese document. (#10588)shela2020-10-101-9/+10
|
* Docs: fix udev rulesErovia2020-10-061-22/+39
| | | | | Apparently, udev does not like inline comments. Rules with them are ignored, oops.
* [CLI] Add c2json (#8817)Erovia2020-10-061-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Basic keymap parsing finally works * Add 'keymap.json' creation to the qmk.keymap module * Add tests and fix formatting * Fix/exclude flake8 errors * Convert keymap.c to valid keymap.json * Fix some errors * Add tests * Finalize keymap.json creation, add json template * Add docs * Move pygments to the standard requirements * Add support for nameless layers, fix tests * Fix things after rebase * Add missing 'keymap' value. * Fix missing layer numbers from advanced keycodes Buckwich noticed that if the advanced keycode / layer toggling key contains a number, it goes missing. Now we properly handle them. Thx for noticing! * Apply suggestions from code review * fixup tests Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: skullY <skullydazed@gmail.com>
* Fixes small typo in docs (#10515)Joe Strong2020-10-051-1/+1
|
* Mark 'key_count' as optional within info.json docs (#10513)George Mao2020-10-032-2/+2
| | | | | | | * Update reference_info_json.md key_count is now an optional field because it is better to get the keycount by counting the elements in the layout array. * Updated Japanese documentation as well
* Doc followup 9942 (#10473)nopunin10did2020-10-012-31/+37
| | | | | * Update feature_advanced_keycodes.md * Update mod_tap.md
* Consolidate udev rules into a single file (#9693)Ryan2020-09-272-96/+53
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Consolidate udev rules into a single file * Update rules in doctor.py * Simplify doctor rule checking * Fix errors * Add TMK "FEED" VID to list of deprecated udev rules * A comma would be nice * Split rules back up into bootloaders * Link to docs page in "missing" case * Add Pololu VID * Be more specific about Caterina devices, and add LilyPad PID
| * Be more specific about Caterina devices, and add LilyPad PIDfauxpark2020-09-191-18/+24
| |
| * Add Pololu VIDfauxpark2020-09-191-3/+5
| |
| * Add TMK "FEED" VID to list of deprecated udev rulesfauxpark2020-09-191-14/+0
| |
| * Update rules in doctor.pyfauxpark2020-09-191-2/+2
| |
| * Consolidate udev rules into a single filefauxpark2020-09-191-80/+43
| |
* | [Docs] Wording & formatting changes in the Tapping Force Hold section of the ↵precondition2020-09-261-21/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Tap Hold page + removed trailing whitespaces (#10391) * Wording & formatting changes in Tapping Force Hold The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes around "tapping". * Removed all trailing whitespaces from tap hold doc * "it's simply really:" → "it's simple really:" * "This allows to keep the ability" → "This allows keeping the ability" Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs. Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
* | [Docs] Japanese translation of docs/understanding_qmk.md (#10136)umi2020-09-221-0/+195
| | | | | | | | | | | | | | | | | | | | | | | | | | * add understanding_qmk.md translation * update based on comment * update based on comment * update based on comment * update based on comment * update based on comment
* | Add description in Bluetooth docs for requiring NKRO to be disabled (#10359)Peter Landoll2020-09-221-1/+4
| |
* | Add OLED driver function to determine if the screen is currently on (#10382)Fred Silberberg2020-09-211-0/+4
| |
* | [Docs] Clarify functionality of update_tri_layer_state (#10370)Dustin Bosveld2020-09-211-2/+4
|/ | | | | | | | | | | | * Add information to docs - If layer z is not a higher layer than both x and y, the layer change code does not function correctly. * Update docs/ref_functions.md * Update docs/ref_functions.md * Update docs/ref_functions.md
* [Docs] Japanese translation of docs/tap_hold.md (#10017)umi2020-09-171-0/+195
| | | | | | | | | * add tap_hold.md translation * update based on comment * update based on comment * update based on comment
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-26 14:18:52 +0000