From d2d9fc86cf0ed0ab4bb896ee247fb212512d5aaf Mon Sep 17 00:00:00 2001
From: Pete Johanson <peter@peterjohanson.com>
Date: Tue, 18 Aug 2020 15:24:38 -0400
Subject: [PATCH] feat(docs): Basic mod-tap behavior docs.

---
 docs/docs/behavior/mod-tap.md | 29 +++++++++++++++++++++++++++++
 docs/sidebars.js              |  1 +
 2 files changed, 30 insertions(+)
 create mode 100644 docs/docs/behavior/mod-tap.md

diff --git a/docs/docs/behavior/mod-tap.md b/docs/docs/behavior/mod-tap.md
new file mode 100644
index 00000000..cae667e3
--- /dev/null
+++ b/docs/docs/behavior/mod-tap.md
@@ -0,0 +1,29 @@
+---
+title: Mod-Tap
+---
+
+## Summary
+
+The Mod-Tap behavior allows varying the effect of pressing and releasing a key position depending
+on whether it is used with other simultaneous key presses at the same time.
+
+If pressed and released independently, the Mod-Tap behavior will send the press and release events
+for the configure keycode. If pressed and held while another key is pressed and released, then
+the configured modifiers will be applied to that _other_ key press, and no press will be generated
+on the release of the Mod-Tap key.
+
+## Mod-Tap
+
+The Mod-Tap behavior either acts as a held modifier, or as a tapped keycode.
+
+### Behavior Binding
+
+- Reference: `&mt`
+- Parameter #1: The modifiers to be used when activating as a modifier, e.g. `MOD_LSFT`
+- Parameter #2: The keycode to sent when used as a tap, e.g. `A`, `B`.
+
+Example:
+
+```
+&mt MOD_LSFT A
+```
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 90bdfa28..be02a657 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -11,6 +11,7 @@ module.exports = {
       "behavior/key-press",
       "behavior/layers",
       "behavior/misc",
+      "behavior/mod-tap",
       "behavior/lighting",
     ],
     Development: [