Skip to content

Commit 00e3e19

Browse files
authored
feat(docs): Update and apply kbd tag style guide (#2930)
- Based on feed back from @mgeisler, update the kbd tag guidance in GEMINI.md to require wrapping each key in its own tag (e.g., `<kbd>Ctrl</kbd> + <kbd>S</kbd>`). - Apply this new convention to existing content in the `src` directory to ensure consistency.
1 parent 096a0a6 commit 00e3e19

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

GEMINI.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,8 @@ list of options.
141141

142142
- **HTML Tags:**
143143
- **`<details>`:** Used for collapsible "speaker notes".
144-
- **`<kbd>`:** Used to denote keyboard keys. Key combinations must be
145-
formatted as `<kbd>Ctrl + S</kbd>`, wrapping the entire combination in one
146-
tag.
144+
- **`<kbd>`:** Used to denote keyboard keys. Each key in a combination must be
145+
wrapped in its own tag, e.g., `<kbd>Ctrl</kbd> + <kbd>S</kbd>`.
147146
- **`<style>`:** Used rarely for targeted custom CSS.
148147
- **`<img>`:** Used to embed images.
149148

src/cargo/code-samples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ fn main() {
1616
}
1717
```
1818

19-
You can use <kbd>Ctrl + Enter</kbd> to execute the code when focus is in the
20-
text box.
19+
You can use <kbd>Ctrl</kbd> + <kbd>Enter</kbd> to execute the code when focus is
20+
in the text box.
2121

2222
<details>
2323

src/running-the-course/keyboard-shortcuts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ There are several useful keyboard shortcuts in mdBook:
44

55
- <kbd>Arrow-Left</kbd>: Navigate to the previous page.
66
- <kbd>Arrow-Right</kbd>: Navigate to the next page.
7-
- <kbd>Ctrl + Enter</kbd>: Execute the code sample that has focus.
7+
- <kbd>Ctrl</kbd> + <kbd>Enter</kbd>: Execute the code sample that has focus.
88
- <kbd>s</kbd>: Activate the search bar.
99

1010
<details>
@@ -14,7 +14,7 @@ There are several useful keyboard shortcuts in mdBook:
1414
- You can demonstrate each shortcut live to the students.
1515
- The <kbd>s</kbd> key for search is particularly useful for quickly finding
1616
topics that have been discussed earlier.
17-
- <kbd>Ctrl + Enter</kbd> will be super important for you since you'll do a lot
18-
of live coding.
17+
- <kbd>Ctrl</kbd> + <kbd>Enter</kbd> will be super important for you since
18+
you'll do a lot of live coding.
1919

2020
</details>

0 commit comments

Comments
 (0)