kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add the doc page to the sidebar

Browse source
This commit is contained in:
krikun98 2021-05-02 18:36:09 +03:00 • committed by Alexander Krikun
parent 571e457866
commit 0893c768fc
2 changed files with 27 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
docs/docs/intro.md
View file

@ -14,32 +14,32 @@ ZMK is currently missing some features found in other popular firmware. This tab
| Legend: | ✅ Supported | 🚧 Under Development | 💡 Planned | | Legend: | ✅ Supported | 🚧 Under Development | 💡 Planned |
| :------ | :----------- | :------------------- | :--------- | | :------ | :----------- | :------------------- | :--------- |
| **Feature** | ZMK | BlueMicro | QMK | | **Feature** | ZMK | BlueMicro | QMK |
| ---------------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: | | ------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
| Low Latency BLE Support | ✅ | ✅ | | | Low Latency BLE Support | ✅ | ✅ | |
| Multi-Device BLE Support | ✅ | | | | Multi-Device BLE Support | ✅ | | |
| [USB Connectivity](behaviors/outputs.md) | ✅ | ✅ | ✅ | | [USB Connectivity](behaviors/outputs) | ✅ | ✅ | ✅ |
| User Configuration Repositories | ✅ | | | | User Configuration Repositories | ✅ | | |
| Split Keyboard Support | ✅ | ✅ | ✅ | | Split Keyboard Support | ✅ | ✅ | ✅ |
| [Keymaps and Layers](behaviors/layers.md) | ✅ | ✅ | ✅ | | [Keymaps and Layers](behaviors/layers) | ✅ | ✅ | ✅ |
| [Hold-Tap](behaviors/hold-tap.md) (which includes [Mod-Tap](behaviors/mod-tap.md) and [Layer-Tap](behaviors/layers.md/#layer-tap)) | ✅ | ✅ | ✅ | | [Hold-Tap](behaviors/hold-tap) (which includes [Mod-Tap](behaviors/mod-tap) and [Layer-Tap](behaviors/layers/#layer-tap)) | ✅ | ✅ | ✅ |
| [Keyboard Codes](codes/index.mdx#keyboard) | ✅ | ✅ | ✅ | | [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
| [Media](codes/index.mdx#media-controls) & [Consumer](codes/index.mdx#consumer-controls) Codes | ✅ | ✅ | ✅ | | [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
| [Encoders](features/encoders.md)[^1] | ✅ | ✅ | ✅ | | [Encoders](features/encoders)[^1] | ✅ | ✅ | ✅ |
| [Display Support](features/displays.md)[^2] | 🚧 | 🚧 | ✅ | | [Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ |
| [RGB Underglow](features/underglow.md) | ✅ | ✅ | ✅ | | [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ |
| One Shot Keys | ✅ | ✅ | ✅ | | One Shot Keys | ✅ | ✅ | ✅ |
| [Combo Keys](features/combos.md) | ✅ | | ✅ | | [Combo Keys](features/combos) | ✅ | | ✅ |
| Macros | 🚧 | ✅ | ✅ | | Macros | 🚧 | ✅ | ✅ |
| Mouse Keys | 🚧 | ✅ | ✅ | | Mouse Keys | ✅ | ✅ | ✅ |
| Low Active Power Usage | ✅ | | | | Low Active Power Usage | ✅ | | |
| Low Power Sleep States | ✅ | ✅ | | | Low Power Sleep States | ✅ | ✅ | |
| [Low Power Mode (VCC Shutoff)](behaviors/power.md) | ✅ | ✅ | | | [Low Power Mode (VCC Shutoff)](behaviors/power) | ✅ | ✅ | |
| Battery Reporting | ✅ | ✅ | | | Battery Reporting | ✅ | ✅ | |
| Shell over BLE | 💡 | | | | Shell over BLE | 💡 | | |
| Realtime Keymap Updating | 💡 | | ✅ | | Realtime Keymap Updating | 💡 | | ✅ |
| AVR/8 Bit | | | ✅ | | AVR/8 Bit | | | ✅ |
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | | | [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | |
[^2]: Encoders are not currently supported on peripheral side splits. [^2]: Encoders are not currently supported on peripheral side splits.
[^1]: OLEDs are currently proof of concept in ZMK. [^1]: OLEDs are currently proof of concept in ZMK.

1
docs/sidebars.js
View file

@ -28,6 +28,7 @@ module.exports = {
"behaviors/sticky-key", "behaviors/sticky-key",
"behaviors/sticky-layer", "behaviors/sticky-layer",
"behaviors/caps-word", "behaviors/caps-word",
"behaviors/mouse-emulation",
"behaviors/reset", "behaviors/reset",
"behaviors/bluetooth", "behaviors/bluetooth",
"behaviors/outputs", "behaviors/outputs",