summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--book.json47
-rw-r--r--docs/custom_quantum_functions.md2
-rw-r--r--docs/understanding_qmk.md2
3 files changed, 36 insertions, 15 deletions
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 @@
+<!-- toc -->
+
# 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 @@
+<!-- toc -->
+
# 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: