キーボードキー#

プロダクトドキュメントやエディタガイドでは、Ctrl K や Command Shift P のようなショートカットを出すことがよくあります。{kbd:...} 記法はオプトインで、既定はオフです。

オプション	型	既定
`keyboardKeys`	`boolean` / `KeyboardKeysOptions`	`false`

import { oxContent } from "@ox-content/vite-plugin";

export default {
  plugins: [
    oxContent({
      keyboardKeys: true,
    }),
  ],
};

false または省略はソースを変えません。true またはオブジェクトは変換をオンにします。クライアント JavaScript はなく、実行時のプラットフォーム判定もしません。

書き方#

{kbd:Ctrl+K} または {kbd:Cmd Shift P} と書きます。+ と空白のどちらでもキーを分けます。レンダラは安定した class 付きの入れ子 <kbd> を出します。

CtrlK CommandShiftP Esc

Press {kbd:Ctrl+K} or {kbd:Cmd Shift P}.

Press CtrlK or CommandShiftP.

単一キー、句読点、組み合わせはすべて有効です。cmd、ctrl、shift、esc などの組み込みエイリアスは、機能がオンのときだけ正規化します。未知のトークンは書いたまま残します。

`{kbd:Ctrl+K}`

{kbd:Ctrl+K}

リテラルにするにはバックスラッシュでエスケープします。\{kbd:Ctrl+K} は {kbd:Ctrl+K} のままです。空、閉じていない、改行をまたぐ記法は見えるまま残します。フェンス、インデントコード、インラインコード、HTML コメント、生の code / pre / script / style は書き換えません。

オプション#

oxContent({
  keyboardKeys: {
    style: "symbols",
    aliases: {
      cmd: "Cmd",
    },
  },
});

フィールド	型	既定
`enabled`	`boolean`	`true`
`style`	`"words"` / `"symbols"`	`"words"`
`aliases`	`Record<string, string>`	`{}`

style: "words" は cmd を Command にします。style: "symbols" は ⌘ にします。カスタム aliases は大文字小文字を区別せず、組み込み表を上書きします。ラベルはビルド時に決まります。

キーボードキー#

書き方#

オプション#

関連#