refactor(docs): Use .mdx for docs with mdx features

Also applies prettier changes in touched files due to precommit
This commit is contained in:
Cem Aksoylar
2024-01-12 20:18:59 -08:00
parent 00962a7255
commit f014eb45a7
30 changed files with 162 additions and 146 deletions

View File

@@ -3,8 +3,8 @@ title: Backlight
sidebar_label: Backlight
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
Backlight is a feature used to control an array of LEDs, usually placed through or under switches.

View File

@@ -3,8 +3,8 @@ title: Beta Testing
sidebar_label: Beta Testing
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
You may find that ZMK does not support a feature or keyboard that you are interesting in using. You may find that someone
has already taken the time to submit the feature you need as a [Pull Request](https://github.com/zmkfirmware/zmk/pulls). If you find the feature you need as a pull request,

View File

@@ -30,7 +30,7 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod
- `layers = <0 1...>` will allow limiting a combo to specific layers. This is an _optional_ parameter, when omitted it defaults to global scope.
- `bindings` is the behavior that is activated when the behavior is pressed.
- (advanced) you can specify `slow-release` if you want the combo binding to be released when all key-positions are released. The default is to release the combo as soon as any of the keys in the combo is released.
- (advanced) you can specify a `require-prior-idle-ms` value much like for [hold-taps](behaviors/hold-tap.md#require-prior-idle-ms). If any non-modifier key is pressed within `require-prior-idle-ms` before a key in the combo, the combo will not trigger.
- (advanced) you can specify a `require-prior-idle-ms` value much like for [hold-taps](behaviors/hold-tap.mdx#require-prior-idle-ms). If any non-modifier key is pressed within `require-prior-idle-ms` before a key in the combo, the combo will not trigger.
:::info

View File

@@ -41,4 +41,4 @@ Here, the left encoder is configured to control volume up and down while the rig
## Adding Encoder Support
See the [New Keyboard Shield](../development/new-shield.md#encoders) documentation for how to add or modify additional encoders to your shield.
See the [New Keyboard Shield](../development/new-shield.mdx#encoders) documentation for how to add or modify additional encoders to your shield.

View File

@@ -3,8 +3,8 @@ title: Keymaps & Behaviors
sidebar_label: Keymaps
---
import KeymapExample from '../keymap-example.md';
import KeymapExampleFile from '../keymap-example-file.md';
import KeymapExample from "../keymap-example.md";
import KeymapExampleFile from "../keymap-example-file.md";
ZMK uses a declarative approach to keymaps instead of using C code for all keymap configuration.
Right now, ZMK uses the devicetree syntax to declare those keymaps; future work is envisioned for
@@ -124,7 +124,7 @@ Nested under the devicetree root, is the keymap node. The node _name_ itself is
Each layer of your keymap will be nested under the keymap node. Here is a sample
that defines just one layer for this keymap:
<KeymapExample/>
<KeymapExample />
Each layer should have:
@@ -137,4 +137,4 @@ For the full set of possible behaviors, start at the [Key Press](../behaviors/ke
Putting this all together, a complete [`kyria.keymap`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/kyria.keymap) looks like:
<KeymapExampleFile/>
<KeymapExampleFile />

View File

@@ -6,7 +6,7 @@ sidebar_label: RGB Underglow
RGB underglow is a feature used to control "strips" of RGB LEDs. Most of the time this is called underglow and creates a glow underneath the board using a ring of LEDs around the edge, hence the name. However, this can be extended to be used to control anything from a single LED to a long string of LEDs anywhere on the keyboard.
:::info
RGB underglow can also be used for under-key lighting. If you have RGB LEDs on your keyboard, this is what you want. For PWM/single color LEDs, see [Backlight](backlight.md).
RGB underglow can also be used for under-key lighting. If you have RGB LEDs on your keyboard, this is what you want. For PWM/single color LEDs, see [Backlight](backlight.mdx).
:::
ZMK supports all the RGB LEDs supported by Zephyr. Here's the current list supported: