Add Ukrainian keymap header (#16947)

* Add Ukrainian keymap header

* Docs

1 files changed, 134 insertions, 0 deletions

diff --git a/quantum/keymap_extras/keymap_ukrainian.h b/quantum/keymap_extras/keymap_ukrainian.h
new file mode 100644
index 0000000000..e5cd80f3d2
--- /dev/null
+++ b/quantum/keymap_extras/keymap_ukrainian.h
@@ -0,0 +1,134 @@
+/* Copyright 2022
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "keymap.h"
+
+// clang-format off
+
+/*
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+ * │ ' │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │       │
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+ * │     │ Й │ Ц │ У │ К │ Е │ Н │ Г │ Ш │ Щ │ З │ Х │ Ї │  \  │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+ * │      │ Ф │ І │ В │ А │ П │ Р │ О │ Л │ Д │ Ж │ Є │        │
+ * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
+ * │        │ Я │ Ч │ С │ М │ И │ Т │ Ь │ Б │ Ю │ . │          │
+ * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
+ * │    │    │    │                        │    │    │    │    │
+ * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
+ */
+// Row 1
+#define UA_QUOT KC_GRV  // '
+#define UA_1    KC_1    // 1
+#define UA_2    KC_2    // 2
+#define UA_3    KC_3    // 3
+#define UA_4    KC_4    // 4
+#define UA_5    KC_5    // 5
+#define UA_6    KC_6    // 6
+#define UA_7    KC_7    // 7
+#define UA_8    KC_8    // 8
+#define UA_9    KC_9    // 9
+#define UA_0    KC_0    // 0
+#define UA_MINS KC_MINS // -
+#define UA_EQL  KC_EQL  // =
+// Row 2
+#define UA_YOT  KC_Q    // Й
+#define UA_TSE  KC_W    // Ц
+#define UA_U    KC_E    // У
+#define UA_KA   KC_R    // К
+#define UA_E    KC_T    // Е
+#define UA_EN   KC_Y    // Н
+#define UA_HE   KC_U    // Г
+#define UA_SHA  KC_I    // Ш
+#define UA_SHCH KC_O    // Щ
+#define UA_ZE   KC_P    // З
+#define UA_KHA  KC_LBRC // Х
+#define UA_YI   KC_RBRC // Ї
+#define UA_BSLS KC_BSLS // (backslash)
+// Row 3
+#define UA_EF   KC_A    // Ф
+#define UA_I    KC_S    // І
+#define UA_VE   KC_D    // В
+#define UA_A    KC_F    // А
+#define UA_PE   KC_G    // П
+#define UA_ER   KC_H    // Р
+#define UA_O    KC_J    // О
+#define UA_EL   KC_K    // Л
+#define UA_DE   KC_L    // Д
+#define UA_ZHE  KC_SCLN // Ж
+#define UA_YE   KC_QUOT // Є
+// Row 4
+#define UA_YA   KC_Z    // Я
+#define UA_CHE  KC_X    // Ч
+#define UA_ES   KC_C    // С
+#define UA_EM   KC_V    // М
+#define UA_Y    KC_B    // И
+#define UA_TE   KC_N    // Т
+#define UA_SOFT KC_M    // Ь
+#define UA_BE   KC_COMM // Б
+#define UA_YU   KC_DOT  // Ю
+#define UA_DOT  KC_SLSH // .
+
+/* Shifted symbols
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+ * │ ₴ │ ! │ " │ № │ ; │ % │ : │ ? │ * │ ( │ ) │ _ │ + │       │
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+ * │     │   │   │   │   │   │   │   │   │   │   │   │   │  /  │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+ * │      │   │   │   │   │   │   │   │   │   │   │   │        │
+ * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
+ * │        │   │   │   │   │   │   │   │   │   │ , │          │
+ * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
+ * │    │    │    │                        │    │    │    │    │
+ * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
+ */
+// Row 1
+#define UA_HRYV S(UA_QUOT) // ₴
+#define UA_EXLM S(UA_1)    // !
+#define UA_DQUO S(UA_2)    // "
+#define UA_NUM  S(UA_3)    // №
+#define UA_SCLN S(UA_4)    // ;
+#define UA_PERC S(UA_5)    // %
+#define UA_COLN S(UA_6)    // :
+#define UA_QUES S(UA_7)    // ?
+#define UA_ASTR S(UA_8)    // *
+#define UA_LPRN S(UA_9)    // (
+#define UA_RPRN S(UA_0)    // )
+#define UA_UNDS S(UA_MINS) // _
+#define UA_PLUS S(UA_EQL)  // +
+// Row 2
+#define UA_SLSH S(UA_BSLS) // /
+// Row 4
+#define UA_COMM S(UA_DOT)  // ,
+
+/* AltGr symbols
+ * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+ * │   │   │   │   │   │   │   │   │   │   │   │   │   │       │
+ * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+ * │     │   │   │   │   │   │   │ ґ │   │   │   │   │   │     │
+ * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+ * │      │   │   │   │   │   │   │   │   │   │   │   │        │
+ * ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
+ * │        │   │   │   │   │   │   │   │   │   │   │          │
+ * ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤
+ * │    │    │    │                        │    │    │    │    │
+ * └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘
+ */
+// Row 2
+#define UA_GE   ALGR(UA_HE) // ґ