Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

refactor(docs): Use new admonition title syntax and disable mdx v1 compat

Browse Source
This commit is contained in:
Cem Aksoylar
2024-01-12 20:34:12 -08:00
parent ee855de349
commit dcfe07d9f6
13 changed files with 26 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/user-setup.mdx
View File

@@ -103,7 +103,7 @@ Keyboard Selection:
Pick an keyboard:
```
:::note For a keyboard not in the included list:
:::note[For a keyboard not in the included list:]
If you are building firmware for a new keyboard that is not included in the built-in
list of keyboards, you can choose any keyboard from the list that is similar to yours (e.g. in terms of unibody/split and [onboard controller](hardware.mdx#onboard)/[composite](hardware.mdx#composite)) to generate the repository,
and edit / add necessary files. You can follow the [new shield guide](development/new-shield.mdx) if you are adding support for a composite keyboard.
@@ -202,7 +202,7 @@ storage device. Once the flash is complete, the controller should unmount the US
flashed firmware. It is recommended that you test your keyboard works over USB first to rule out hardware issues, before trying to
connect to it wirelessly.
:::warning Split keyboards
:::warning[Split keyboards]
For split keyboards, only the central half (typically the left side) will send keyboard outputs over USB or advertise to other devices
over bluetooth. Peripheral half will only send keystrokes to the central once they are paired and connected. For this reason it is