diff options
| -rw-r--r-- | book.json | 14 | ||||
| -rw-r--r-- | docs/custom_quantum_functions.md | 4 | ||||
| -rw-r--r-- | docs/understanding_qmk.md | 4 |
3 files changed, 18 insertions, 4 deletions
@@ -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 @@ -<!-- toc --> - # How To Customize Your Keyboard's Behavior +<!-- toc --> + 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 @@ -<!-- toc --> - # Understanding QMK's Code +<!-- toc --> + 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) |