ZMK Firmware リファレンス

ZMK Firmware — Zephyr RTOS 上に構築されたオープンソース (MIT) のキーボードファームウェア。 省電力・無線・分割キーボード対応を主眼に設計され、devicetree ベースの宣言的設定により多様な MCU（nRF52/RP2/SAMD21/STM32 等）と shield をサポートする。 公式ドキュメント (zmk.dev/docs) の全 11 カテゴリを構造化。 keymap 設計・behaviors 選択・config 設定・新規 board/shield 作成・ローカルビルド・トラブルシューティング時に参照する。

ディレクトリ構成

skills/zmk/
  SKILL.md
  references/
    getting-started/
      README.md
      hardware.md
      user-setup.md
      zmk-cli.md
      customization.md
      faq.md
    features/
      README.md
      bluetooth.md
      split-keyboards.md
      encoders.md
      displays.md
      lighting.md
      pointing.md
      low-power-states.md
      studio.md
      modules.md
      led-indicators.md
      debouncing.md
      battery.md
    keymaps/
      README.md
      overview.md
      list-of-keycodes.md
      modifiers.md
      combos.md
      conditional-layers.md
      keymap-example.md
    behaviors/
      README.md
      overview.md
      key-press.md
      hold-tap.md
      tap-dance.md
      mod-morph.md
      sticky-key.md
      sticky-layer.md
      layers.md
      macros.md
      mouse-emulation.md
      sensor-rotate.md
      bluetooth.md
      outputs.md
      reset.md
      power.md
      soft-off.md
      caps-word.md
      key-repeat.md
      key-toggle.md
      backlight.md
      underglow.md
      studio-unlock.md
      misc.md
    input-processors/
      README.md
      overview.md
      usage.md
      code-mapper.md
      scaler.md
      temp-layer.md
      transformer.md
      behaviors.md
    config/
      README.md
      overview.md
      system.md
      bluetooth.md
      split.md
      kscan.md
      keymap.md
      combos.md
      behaviors.md
      encoders.md
      pointing.md
      displays.md
      lighting.md
      led-indicators.md
      studio.md
      battery.md
      power.md
      settings.md
      layout.md
      bootloader.md
    development/
      README.md
      devicetree.md
      events.md
      new-behavior.md
      module-creation.md
      studio-rpc-protocol.md
      usb-logging.md
    contributing/
      README.md
      clean-room.md
      documentation.md
      pull-requests.md
    hardware-integration/
      README.md
      overview.md
      new-board.md
      new-shield.md
      physical-layouts.md
      pinctrl.md
      hardware-metadata-files.md
      encoders.md
      dongle.md
      battery.md
      shift-registers.md
      soft-off-setup.md
      pointing.md
      bootloader/
        README.md
        overview.md
        adafruit-nrf52.md
        rp2.md
        samd21-uf2.md
        stm32.md
        tinyuf2.md
      lighting/
        README.md
        overview.md
        backlight.md
        underglow.md
        led-indicators.md
    local-toolchain/
      README.md
      setup.md
      setup-container.md
      setup-native.md
      build-flash.md
      ide-integration.md
      posix-board.md
      pre-commit.md
      tests.md
    troubleshooting/
      README.md
      overview.md
      building-issues.md
      flashing-issues.md
      connection-issues.md
      hardware-issues.md
  samples/
    README.md
    basic-keymap.md
    hold-tap-homerow-mods.md
    layer-switching.md
    combos.md
    macros.md
    tap-dance.md
    mod-morph.md
    sticky-key.md
    bluetooth-profiles.md
    encoder-volume-scroll.md
    config-repo-setup.md
  scripts/
    README.md
    install.md
    cli.md
    build.md
    flash.md
    dev-setup.md
    debug.md
    docs.md

探索手順

タスクからカテゴリを引き、カテゴリの README.md で目的のページを特定する:

1. 下記マッピング表でタスクに対応するカテゴリを探す
2. そのカテゴリの references/{category}/README.md を参照して目的のページを特定する
3. 該当ページの .md を Read して詳細を確認する

タスク → カテゴリ マッピング