From b75ad215c85a53c34e170dba3c62093fc8655362 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 12:25:29 -0400 Subject: use default base names --- book.json | 1 - 1 file changed, 1 deletion(-) (limited to 'book.json') diff --git a/book.json b/book.json index ff19e2974a..3da42c4b1c 100644 --- a/book.json +++ b/book.json @@ -1,6 +1,5 @@ { "structure": { - "readme": "home.md", "summary": "_summary.md" }, "plugins" : ["toolbar", "edit-link", "anchors"], -- cgit 1.4.1 From bf3007ec58d336d1ac6a70b6016d716e17ddb3ac Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 11:46:58 -0700 Subject: Add some gitboot plugins --- book.json | 47 +++++++++++++++++++++++++++------------- docs/custom_quantum_functions.md | 2 ++ docs/understanding_qmk.md | 2 ++ 3 files changed, 36 insertions(+), 15 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index 3da42c4b1c..a563184868 100644 --- a/book.json +++ b/book.json @@ -2,22 +2,39 @@ "structure": { "summary": "_summary.md" }, - "plugins" : ["toolbar", "edit-link", "anchors"], + "plugins" : [ + "anchors", + "toolbar", + "edit-link", + "forkmegithub", + "git-author", + "hints", + "numbered-headings", + "etoc", + "terminal", + ], "pluginsConfig": { - "edit-link": { - "base": "https://github.com/qmk/qmk_firmware/edit/master/docs", - "label": "Suggest an edit" - }, - "toolbar": { - "buttons": - [ - { - "label": "QMK Firmware", - "icon": "fa fa-github", - "url": "https://github.com/qmk/qmk_firmware" - } - ] - } + "edit-link": { + "base": "https://github.com/qmk/qmk_firmware/edit/master/docs", + "label": "Suggest an edit" + }, + "forkmegithub": { + "color": "darkblue", + "url": "https://github.com/qmk/qmk_firmware" + }, + "etoc": { + "maxdepth": 3, + "notoc": true + } + "toolbar": { + "buttons": [ + { + "label": "QMK Firmware", + "icon": "fa fa-github", + "url": "https://github.com/qmk/qmk_firmware" + } + ] + } }, "root": "./docs/" } diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 3127f89445..3d6c874167 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md @@ -1,3 +1,5 @@ + + # How To Customize Your Keyboard's Behavior For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations. diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md index 1b240fc87c..dfc84c29c6 100644 --- a/docs/understanding_qmk.md +++ b/docs/understanding_qmk.md @@ -1,3 +1,5 @@ + + # Understanding QMK's Code This document attempts to explain how the QMK firmware works from a very high level. It assumes you understand basic programming concepts but does not (except where needed to demonstrate) assume familiarity with C. It assumes that you have a basic understanding of the following documents: -- cgit 1.4.1 From ada64b8ec96ccccc8b0af129cb63e49917b7f43f Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 11:49:47 -0700 Subject: add missing comma --- book.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book.json') diff --git a/book.json b/book.json index a563184868..2beadd31a8 100644 --- a/book.json +++ b/book.json @@ -25,7 +25,7 @@ "etoc": { "maxdepth": 3, "notoc": true - } + }, "toolbar": { "buttons": [ { -- cgit 1.4.1 From ad913864977f04b6005723f83397d35d74b33c74 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 17:13:42 -0400 Subject: remove dangling commas --- book.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index 2beadd31a8..8bf9921a83 100644 --- a/book.json +++ b/book.json @@ -4,14 +4,14 @@ }, "plugins" : [ "anchors", - "toolbar", "edit-link", + "etoc", "forkmegithub", "git-author", "hints", "numbered-headings", - "etoc", "terminal", + "toolbar" ], "pluginsConfig": { "edit-link": { -- cgit 1.4.1 From 780786596d7d454d89e5b1ebf960884d99229d95 Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 11:55:26 -0700 Subject: remove most of the new plugins --- book.json | 4 ---- 1 file changed, 4 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index 8bf9921a83..613c50dd8c 100644 --- a/book.json +++ b/book.json @@ -6,11 +6,7 @@ "anchors", "edit-link", "etoc", - "forkmegithub", - "git-author", - "hints", "numbered-headings", - "terminal", "toolbar" ], "pluginsConfig": { -- cgit 1.4.1 From a5bb83cbf3f82577c3b29a1bd47b58cf5e564775 Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 11:56:29 -0700 Subject: remove the rest of the new plugins --- book.json | 2 -- 1 file changed, 2 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index 613c50dd8c..860ca26c82 100644 --- a/book.json +++ b/book.json @@ -5,8 +5,6 @@ "plugins" : [ "anchors", "edit-link", - "etoc", - "numbered-headings", "toolbar" ], "pluginsConfig": { -- cgit 1.4.1 From 2e9e1eb03cc0dbf3a0a99b0690a45392197e520a Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 12:19:16 -0700 Subject: remove extraneous config --- book.json | 8 -------- 1 file changed, 8 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index 860ca26c82..b6f90fc110 100644 --- a/book.json +++ b/book.json @@ -12,14 +12,6 @@ "base": "https://github.com/qmk/qmk_firmware/edit/master/docs", "label": "Suggest an edit" }, - "forkmegithub": { - "color": "darkblue", - "url": "https://github.com/qmk/qmk_firmware" - }, - "etoc": { - "maxdepth": 3, - "notoc": true - }, "toolbar": { "buttons": [ { -- cgit 1.4.1 From 7da94ac51bf77d74b42ab63c06358ff59072289b Mon Sep 17 00:00:00 2001 From: skullY Date: Thu, 29 Jun 2017 12:24:24 -0700 Subject: Fixup the gitbook config --- book.json | 14 ++++++++++++++ docs/custom_quantum_functions.md | 4 ++-- docs/understanding_qmk.md | 4 ++-- 3 files changed, 18 insertions(+), 4 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index b6f90fc110..edbae4c66f 100644 --- a/book.json +++ b/book.json @@ -5,6 +5,12 @@ "plugins" : [ "anchors", "edit-link", + "etoc", + "forkmegithub", + "git-author", + "hints", + "numbered-headings", + "terminal", "toolbar" ], "pluginsConfig": { @@ -12,6 +18,14 @@ "base": "https://github.com/qmk/qmk_firmware/edit/master/docs", "label": "Suggest an edit" }, + "forkmegithub": { + "color": "red", + "url": "https://github.com/qmk/qmk_firmware" + }, + "etoc": { + "maxdepth": 3, + "notoc": true + }, "toolbar": { "buttons": [ { diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 3d6c874167..ede0aebfc9 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md @@ -1,7 +1,7 @@ - - # How To Customize Your Keyboard's Behavior + + For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations. This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.html) will help you understand what is going on at a more fundamental level. diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md index dfc84c29c6..f01d50416c 100644 --- a/docs/understanding_qmk.md +++ b/docs/understanding_qmk.md @@ -1,7 +1,7 @@ - - # Understanding QMK's Code + + This document attempts to explain how the QMK firmware works from a very high level. It assumes you understand basic programming concepts but does not (except where needed to demonstrate) assume familiarity with C. It assumes that you have a basic understanding of the following documents: * [QMK Overview](qmk_overview.md) -- cgit 1.4.1 From dcd715ed4d3c57a3776695dcea18c63feaf7b84c Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Jun 2017 09:33:03 -0700 Subject: Try neo-navigator in place of etoc --- book.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index edbae4c66f..94ceeb1c3e 100644 --- a/book.json +++ b/book.json @@ -5,7 +5,7 @@ "plugins" : [ "anchors", "edit-link", - "etoc", + "neo-navigator", "forkmegithub", "git-author", "hints", @@ -22,10 +22,6 @@ "color": "red", "url": "https://github.com/qmk/qmk_firmware" }, - "etoc": { - "maxdepth": 3, - "notoc": true - }, "toolbar": { "buttons": [ { -- cgit 1.4.1 From 77ab0f16a0a72a1e9b2b4c82a01773c9270ce82d Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Jun 2017 09:38:54 -0700 Subject: use navigator instead of neo-navigator --- book.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book.json') diff --git a/book.json b/book.json index 94ceeb1c3e..555d367580 100644 --- a/book.json +++ b/book.json @@ -5,7 +5,7 @@ "plugins" : [ "anchors", "edit-link", - "neo-navigator", + "navigator", "forkmegithub", "git-author", "hints", -- cgit 1.4.1 From d6d14b67940c8de09a13fee4fe7ff30623d4653e Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Jun 2017 09:50:12 -0700 Subject: try page-toc in place of navigator --- book.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book.json') diff --git a/book.json b/book.json index 555d367580..f994114348 100644 --- a/book.json +++ b/book.json @@ -5,11 +5,11 @@ "plugins" : [ "anchors", "edit-link", - "navigator", "forkmegithub", "git-author", "hints", "numbered-headings", + "page-toc", "terminal", "toolbar" ], -- cgit 1.4.1 From 486abde026a2e2d44a09477bbeb4ff122c104f1d Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Jun 2017 10:06:40 -0700 Subject: tweak page-toc settings --- book.json | 3 +++ docs/custom_quantum_functions.md | 26 +++++++++++++------------- 2 files changed, 16 insertions(+), 13 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index f994114348..b7c62b1dd3 100644 --- a/book.json +++ b/book.json @@ -22,6 +22,9 @@ "color": "red", "url": "https://github.com/qmk/qmk_firmware" }, + "page-toc": { + "selector": ".markdown-section h1, .markdown-section h2, .markdown-section h3" + }, "toolbar": { "buttons": [ { diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 9faac9d7e6..17615d991c 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md @@ -16,11 +16,11 @@ Each of the functions described below can be defined with a `_kb()` suffix or a When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called. -## Custom Keycodes +# Custom Keycodes By far the most common task is to change the behavior of an existing keycode or to create a new keycode. From a code standpoint the mechanism for each is very similar. -### Defining a New Keycode +## Defining a New Keycode The first step to creating your own custom keycode(s) is to enumerate them. This means both naming them and assigning a unique number to that keycode. Rather than limit custom keycodes to a fixed range of numbers QMK provides the `SAFE_RANGE` macro. You can use `SAFE_RANGE` when enumerating your custom keycodes to guarantee that you get a unique number. @@ -34,13 +34,13 @@ enum my_keycodes { }; ``` -### Programming The Behavior Of A Keycode +## Programming The Behavior Of A Keycode When you want to override the behavior of an existing key, or define the behavior for a new key, you should use the `process_record_{kb,user}()` functions. These are called by QMK during key processing before the actual key event is handled. If these functions return `true` QMK will process the keycodes as usual. That can be handy for extending the functionality of a key rather than replacing it. If these functions return `false` QMK will skip the normal key handling, and it will be up you to send and key up or down events that are required. These function are called every time a key is pressed or released. -#### Example `process_record_user()` implementation +### Example `process_record_user()` implementation This example does two things. It defines the behavior for a custom keycode called `FOO`, and it supplements our Enter key by playing a tone whenever it is pressed. @@ -64,7 +64,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { } ``` -#### `process_record_*` Function documentation +### `process_record_*` Function documentation * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` @@ -86,7 +86,7 @@ keyrecord_t record { } ``` -### LED Control +## LED Control This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes. @@ -96,7 +96,7 @@ This allows you to control the 5 LED's defined as part of the USB Keyboard spec. * `USB_LED_COMPOSE` * `USB_LED_KANA` -#### Example `led_set_kb()` implementation +### Example `led_set_kb()` implementation ``` void led_set_kb(uint8_t usb_led) { @@ -128,12 +128,12 @@ void led_set_kb(uint8_t usb_led) { } ``` -#### `led_set_*` Function documentation +### `led_set_*` Function documentation * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` * Keymap: `void led_set_user(uint8_t usb_led)` -### Matrix Initialization Code +## Matrix Initialization Code Before a keyboard can be used the hardware must be initialized. QMK handles initialization of the keyboard matrix itself, but if you have other hardware like LED's or i²c controllers you will need to set up that hardware before it can be used. @@ -153,20 +153,20 @@ void matrix_init_kb(void) { } ``` -#### `matrix_init_*` Function documentation +### `matrix_init_*` Function documentation * Keyboard/Revision: `void matrix_init_kb(void)` * Keymap: `void matrix_init_user(void)` -### Matrix Scanning Code +## Matrix Scanning Code Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second. -#### Example `matrix_scan_*` implementation +### Example `matrix_scan_*` implementation This example has been deliberately omitted. You should understand enough about QMK internals to write this without an example before hooking into such a performance sensitive area. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on gitter](https://gitter.im/qmk/qmk_firmware). -#### `matrix_scan_*` Function documentation +### `matrix_scan_*` Function documentation * Keyboard/Revision: `void matrix_scan_kb(void)` * Keymap: `void matrix_scan_user(void)` -- cgit 1.4.1 From ea8df568f23b79eba13ef9e914d8b1ce94688858 Mon Sep 17 00:00:00 2001 From: skullY Date: Fri, 30 Jun 2017 10:11:54 -0700 Subject: reduce the TOC scope --- book.json | 2 +- docs/custom_quantum_functions.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'book.json') diff --git a/book.json b/book.json index b7c62b1dd3..887d2a6431 100644 --- a/book.json +++ b/book.json @@ -23,7 +23,7 @@ "url": "https://github.com/qmk/qmk_firmware" }, "page-toc": { - "selector": ".markdown-section h1, .markdown-section h2, .markdown-section h3" + "selector": ".markdown-section h1, .markdown-section h2" }, "toolbar": { "buttons": [ diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 17615d991c..0d6def45bf 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md @@ -86,7 +86,7 @@ keyrecord_t record { } ``` -## LED Control +# LED Control This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes. @@ -133,11 +133,11 @@ void led_set_kb(uint8_t usb_led) { * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` * Keymap: `void led_set_user(uint8_t usb_led)` -## Matrix Initialization Code +# Matrix Initialization Code Before a keyboard can be used the hardware must be initialized. QMK handles initialization of the keyboard matrix itself, but if you have other hardware like LED's or i²c controllers you will need to set up that hardware before it can be used. -#### Example `matrix_init_kb()` implementation +### Example `matrix_init_kb()` implementation This example, at the keyboard level, sets up B1, B2, and B3 as LED pins. @@ -158,7 +158,7 @@ void matrix_init_kb(void) { * Keyboard/Revision: `void matrix_init_kb(void)` * Keymap: `void matrix_init_user(void)` -## Matrix Scanning Code +# Matrix Scanning Code Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second. -- cgit 1.4.1