Commit graph

1642 commits

Author SHA1 Message Date
Albert Y
a63c2c5f50
Add example for turning off RGB colors and retaining indicator function (#14997)
* Add init function for solid effect with colors off

* Restructure sentence

Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-05 19:11:45 +11:00
Ryan
cc5a38e787
Rework ISP flashing guide (#14938)
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
2021-11-05 14:42:08 +11:00
Erovia
c8b09d0d4a
CLI: Add 'cd' subcommand (#12584)
* CLI: Add 'cd' subcommand

Go to your qmk_firmware dir with ease.

* Fix for Windows and do not run if already under QMK Home

* Make flake8 happy

* Fix prompt for Windows

* Make flake8 happy once again

* I'll get it right eventually

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* Add subcommand to __init__.py and fixup after rebase

* Update Windows code to use milc's run

* Unify the subshell starting with os.execl

* Exit with error msg when output is redirected to non-TTY.

* Revert Windows-specific code

Co-authored-by: Ryan <fauxpark@gmail.com>
2021-11-05 08:21:09 +11:00
Mikkel Jeppesen
fefd7fdc51
Refactor new-keyboard to be python3.7 compatible (#14707)
* Use copy_tree from distutils for python 3.7 support

* Bump python version in docs

* Changed new-keyboard to use printf-style format strings

* Use username for manunfacturer / maintainer

* Update lib/python/qmk/cli/new/keyboard.py

Co-authored-by: Zach White <skullydazed@drpepper.org>

Co-authored-by: Zach White <skullydazed@drpepper.org>
2021-11-05 08:14:43 +11:00
Ryan
6437045166
qmk docs: Run docsify serve if available (#15056) 2021-11-05 08:02:27 +11:00
Albert Y
2761b17b98
Clarify placement of configuration options (#15015)
Co-authored-by: filterpaper <filterpaper@localhost>
2021-11-02 17:19:01 +11:00
Albert Y
9b912416b4
[Docs] Add instructions to create keymap before proceeding (#14945)
Co-authored-by: filterpaper <filterpaper@localhost>
2021-10-27 08:03:00 -07:00
Albert Y
c0c7c4692b
Add MAGIC_TOGGLE_GUI line to main keycode documentation (#14959)
Co-authored-by: filterpaper <filterpaper@localhost>
2021-10-27 01:09:12 +01:00
JayceFayne
312b1b95a8
Document MAGIC feature (#14301) 2021-10-26 16:55:04 -07:00
coliss86
0002acd4a3
Fix Typo in documentation (#14942) 2021-10-24 23:32:42 +01:00
ForsakenRei
ff39890620
[Docs] Add default case to tap dance example 5. (#14893) 2021-10-22 23:45:07 -07:00
precondition
5fbcbc6af8
[DOCS] Fix the STENO_COMBINEDMAP table (#14883) 2021-10-20 01:26:59 +11:00
Takeshi ISHII
eddb206369
add docs/ja/ja_doc_status.sh (#14402) 2021-10-16 17:31:09 +09:00
Aaron Paterson
c8b00b2e91
Update documentation because GPIO functions are no longer in quantum.h (#14826)
* GPIO functions are no longer in quantum.h

* Update docs/internals_gpio_control.md

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2021-10-16 01:43:03 +01:00
Ryan
b7a346600c
[Docs] Clean up reference_info_json.md (#14806) 2021-10-15 12:45:33 +11:00
shela
f216c20fc7
Update Japanese document (#14766) 2021-10-09 21:04:00 +01:00
shela
5aca3f613c
Update Japanese document (#14767) 2021-10-09 21:03:17 +01:00
shela
969596bd67
Update Japanese document (#14769) 2021-10-09 21:02:55 +01:00
s-show
7205b70e84
Translate keycodes us ansi shifted (#13820)
* copy "keycodes_us_ansi_shifted.md" to docs/ja.

* Add japanese translation "docs/keycodes_us_ansi_shifted.md".

* Apply suggestions from code review

Co-authored-by: shela <shelaf@users.noreply.github.com>

* Update docs/ja/keycodes_us_ansi_shifted.md

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2021-10-08 19:28:00 +09:00
precondition
13f3e30e86
Fix link from feature_tap_dance.md to tapping term settings (#14741) 2021-10-07 21:03:21 +01:00
Nick Brassel
4676a14596
More PR checklist updates (#14705)
* Wording, clarification.

* Apply suggestions from code review

Co-authored-by: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com>

Co-authored-by: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com>
2021-10-06 06:46:36 +11:00
Nick Brassel
7a49e5d207
Add clarification for licensing. (#14704)
* Add clarification for licensing.

* Errr, v2.
2021-10-05 20:29:52 +11:00
Albert Y
27d9579fd5
Document examples on intercepting Mod-Tap (#14502)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>
Co-authored-by: filterpaper <filterpaper@localhost>
2021-10-04 16:21:02 -07:00
umi
e54a57d32a
[Docs] update Japanese translation of mod_tap.md (#13981)
* update mod_tap.md translation

* add id on config_options.md and update text based on comments
2021-10-01 17:24:53 +09:00
Purdea Andrei
52cb19713b
Fix documentation for NO_HAPTIC_MOD and NO_HAPTIC_FN features. (#14180) 2021-10-01 07:24:19 +10:00
Drashna Jaelre
02ab7b1888
[Core] Fix "6kro enable" and clarify naming (#14563)
* Fix USB_6KRO_ENABLE compilation errors

* Add info to docs

* Rename define to be more accurate

* Remove unused rule

* Refixe docs
2021-09-29 11:37:11 -07:00
clickclackwho
4f37084677
[Docs] Broken FAQ hyperlink (#14578) 2021-09-24 08:43:05 -07:00
umi
30140f48d0
[Docs] update Japanese translation of pr_checklist.md (#13693)
* update pr_checklist.md translation

* update file based on comments

* add id on feature_led_indicators.md and update text based on comments

* update file based on comments

* update file based on comment
2021-09-24 14:51:34 +09:00
umi
0fc15f4d30
[Docs] update Japanese translation of feature_backlight.md (#14403)
* update feature_backlight.md translation

* update file based on comments
2021-09-23 13:02:32 +09:00
umi
7f0c397c72
[Docs] update Japanese translation of feature_advanced_keycodes.md (#14309)
* update feature_advanced_keycodes.md translation

* update file based on comments
2021-09-23 13:01:42 +09:00
umi
5347577346
[Docs] update Japanese translation of isp_flashing_guide.md (#13700)
* update isp_flashing_guide.md translation

* update isp_flashing_guide.md translation

* correct url

* trim remaining merge identifier
2021-09-23 12:58:56 +09:00
umi
7bfc6083b7
[Docs] update Japanese translation of feature_leader_key.md (#13669)
* update feature_leader_key.md translation

* update file based on comments

* update text based on comments
2021-09-23 12:55:19 +09:00
umi
618a28c6ae
[Docs] update Japanese translation of one_shot_keys.md (#13656)
* update one_shot_keys.md translation

* update one_shot_keys.md translation

* correct paramter for function

* add change of #13754
2021-09-23 12:52:53 +09:00
Dasky
45f88af4a1
[Docs] update suspend_*_user examples (#14542) 2021-09-21 16:40:19 -07:00
Dasky
19e33b685f
[Docs] Modify encoder_update_user example to return false (#14541) 2021-09-21 07:52:57 -07:00
XScorpion2
4dbeeaa0d6
Doc Fixes & Custom Matrix Fix (#14526) 2021-09-20 06:18:32 +10:00
David Xia
ddb6821b97
[Docs] fix wrong directory for RGB Matrix animations (#14494) 2021-09-19 11:53:22 -07:00
Dasky
12a8e59e9c
[Docs] add sync options heading, update led indicators (#14441)
Co-authored-by: Ryan <fauxpark@gmail.com>
2021-09-15 10:11:25 -07:00
vsrivastava
657323a206
[Docs] fixed incorrect amount of steps for oled usage (#13519)
changed line 21 from saying "three steps" to "two steps" as there are only two steps

Co-authored-by: feynmantf <46390109+feynmantf@users.noreply.github.com>
2021-09-14 21:12:37 -07:00
umi
10362777a5
update compatible_microcontrollers.md translation (#14401) 2021-09-12 16:08:22 +09:00
Ryan
4791cfae1a
Remove width, height and key_count from info.json (#14274) 2021-09-12 14:04:56 +10:00
Ryan
d5cb7de5e4
Change USBasp and bootloadHID bootloaders to lowercase (#14354) 2021-09-10 17:17:54 +10:00
Joel Challis
7f80076d04
Align rgb/led matrix docs with current behaviour (#14367) 2021-09-10 03:57:36 +01:00
Ryan
9e77cdf4e6
Bugfix for Joystick and JSON schema (#14295) 2021-09-09 10:27:58 +10:00
Niko Wenselowski
8a8fdd9a72
Highlight keycode (#14317)
This should make it consistent with other docs and hopefully will make less people miss this detail.
2021-09-05 20:36:16 +01:00
JayceFayne
767f2c0284
[Core] Add is_oled_scrolling (#14305) 2021-09-05 09:09:20 -07:00
JayceFayne
014aa0661e
Fix Space Cadet md link (#14300) 2021-09-04 15:01:56 +01:00
qieq
bb356a1584
[Docs] Update path to keycode.h (#14263) 2021-09-01 20:40:12 -07:00
coliss86
1e7117317f
Documentation: Fix links in key overrides (#14228)
Co-authored-by: Joel Challis <git@zvecr.com>
2021-08-31 09:13:19 +10:00
Zach White
b705020daf
move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00