Skip to content

Commit a7333d6

Browse files
committed
feat: add developer's keyboard image and note to symbol maps in documentation
1 parent b05a079 commit a7333d6

9 files changed

Lines changed: 44 additions & 0 deletions

File tree

README-ja.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717

1818
## 記号マップ
1919

20+
> この変換表は NoShift.js 開発者のキーボード(JIS 配列)が基準です。
21+
22+
![開発者のキーボード](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
23+
2024
| NoShift | JS | | NoShift | JS |
2125
|:-------:|:--:|---|:-------:|:--:|
2226
| `^1` | `!` | | `^^` | `~` |

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Typing shifted symbols (`!`, `"`, `(`, `)`, `{`, `}` …) is tiring.
1616

1717
## Symbol Map
1818

19+
> This symbol mapping is based on the NoShift.js developer's keyboard (JIS layout).
20+
21+
![Developer's Keyboard](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
22+
1923
| NoShift | JS | | NoShift | JS |
2024
|:-------:|:--:|---|:-------:|:--:|
2125
| `^1` | `!` | | `^^` | `~` |

npm/README-ja.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ nsc --init
6868

6969
## 記号マップ
7070

71+
> この変換表は NoShift.js 開発者のキーボード(JIS 配列)が基準です。
72+
73+
![開発者のキーボード](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
74+
7175
| NoShift | JS | | NoShift | JS |
7276
|:-------:|:--:|---|:-------:|:--:|
7377
| `^1` | `!` | | `^^` | `~` |

npm/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ Generated automatically by `nsc --init` or `nsc create`.
6868

6969
## Symbol Map
7070

71+
> This symbol mapping is based on the NoShift.js developer's keyboard (JIS layout).
72+
73+
![Developer's Keyboard](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
74+
7175
| NoShift | JS | | NoShift | JS |
7276
|:-------:|:--:|---|:-------:|:--:|
7377
| `^1` | `!` | | `^^` | `~` |

pages/src/i18n/translations.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ export const ui = {
8989
"syntax.introDesc":
9090
"NoShift.js uses <code>^</code> (caret) as a prefix to represent shifted symbols. The mapping is based on a Japanese JIS keyboard layout.",
9191
"syntax.tableTitle": "Symbol Map",
92+
"syntax.tableNote":
93+
"This symbol mapping is based on the NoShift.js developer's keyboard (JIS layout).",
9294
"syntax.tableShifted": "Shifted Key",
9395
"syntax.tableNoshift": "NoShift.js",
9496
"syntax.escapeTitle": "Escaping in Strings",
@@ -220,6 +222,8 @@ export const ui = {
220222
"syntax.introDesc":
221223
"NoShift.js は <code>^</code>(キャレット)をプレフィックスとして Shift 記号を表現します。マッピングは日本語 JIS キーボード配列に基づいています。",
222224
"syntax.tableTitle": "記号マップ",
225+
"syntax.tableNote":
226+
"この変換表は NoShift.js 開発者のキーボード(JIS 配列)が基準です。",
223227
"syntax.tableShifted": "Shift 記号",
224228
"syntax.tableNoshift": "NoShift.js",
225229
"syntax.escapeTitle": "文字列内のエスケープ",

pages/src/pages/[lang]/syntax.astro

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ const templateExprLabel =
3636
<p set:html={t(lang, "syntax.introDesc")} />
3737

3838
<h2>{t(lang, "syntax.tableTitle")}</h2>
39+
<div class="callout">
40+
<p>{t(lang, "syntax.tableNote")}</p>
41+
</div>
42+
<img
43+
src="https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg"
44+
alt={lang === "ja" ? "開発者のキーボード" : "Developer's Keyboard"}
45+
class="keyboard-img"
46+
/>
3947
<div class="symbol-grid">
4048
<SymbolTable
4149
headerShifted={t(lang, "syntax.tableShifted")}

pages/src/styles/global.css

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,14 @@ pre code {
465465
margin: 1.5rem 0;
466466
}
467467

468+
.keyboard-img {
469+
display: block;
470+
max-width: 100%;
471+
border-radius: var(--radius-lg);
472+
border: 1px solid var(--border);
473+
margin: 1rem 0 1.5rem;
474+
}
475+
468476
@media (max-width: 600px) {
469477
.symbol-grid {
470478
grid-template-columns: 1fr;

vscode-extension/README-ja.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@
5353

5454
## 言語サポート
5555

56+
> この変換表は NoShift.js 開発者のキーボード(JIS 配列)が基準です。
57+
58+
![開発者のキーボード](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
59+
5660
| 機能 | 詳細 |
5761
|---|---|
5862
| 拡張子 | `.nsjs` |

vscode-extension/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ Result: ^[|^] (| = cursor position)
5353

5454
## Language Support
5555

56+
> This symbol mapping is based on the NoShift.js developer's keyboard (JIS layout).
57+
58+
![Developer's Keyboard](https://raw.githubusercontent.com/otoneko1102/NoShift.js/refs/heads/main/my-keyboard.jpg)
59+
5660
| Feature | Details |
5761
|---|---|
5862
| Extension | `.nsjs` |

0 commit comments

Comments
 (0)