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

feat(docs): add keymap upgrader

Browse Source 
Added a documentation page with a script that upgrades deprecated key
codes and behaviors to their replacements.

Fixes #299
This commit is contained in:
Joel Spadin
2020-11-07 18:03:20 -06:00
committed by innovaker
parent 77c16b020e
commit 5aa8a07aa9
12 changed files with 562 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/docs/codes/keymap-upgrader.mdx Normal file
View File

@@ -0,0 +1,21 @@
---
title: Keymap Upgrader
sidebar_label: Keymap Upgrader
hide_title: true
hide_table_of_contents: true
---
# Keymap Upgrader
Many codes have been renamed to be more consistent with each other.
Paste the contents of a `.keymap` file below to upgrade all deprecated codes to their replacements.
Hover your mouse over the upgraded keymap and click the `Copy` button to copy it to your clipboard.
You will likely need to realign columns in the upgraded keymap. The upgrader also does not handle
codes inside a `#define`, so you will need to update those manually using
[this list of deprecated codes and replacements](https://github.com/zmkfirmware/zmk/blob/main/docs/src/data/keymap-upgrade.js).
import KeymapUpgrader from "@site/src/components/KeymapUpgrader/index";
<KeymapUpgrader />