@lexibase/create-rdx 3.1.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/package.json +1 -1
  2. package/templates/default/docs/examples/keyboard-shortcuts.mdx +29 -13
  3. package/templates/default/package.json +1 -1
  4. package/templates/default/rdx.config.ts +2 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lexibase/create-rdx",
3
- "version": "3.1.0",
3
+ "version": "4.0.0",
4
4
  "description": "Create a new RDX documentation project.",
5
5
  "license": "MIT",
6
6
  "bin": {
package/templates/default/docs/examples/keyboard-shortcuts.mdx CHANGED
@@ -16,28 +16,44 @@ Press :kbd[Esc] to close a dialog or :kbd[Enter] to confirm.
16
16
 
17
17
  ## Write a shortcut
18
18
 
19
- Write the separator as ordinary text between the keys:
19
+ Write the complete combination inside one directive, separating keys with `+`:
20
20
 
21
- Press :kbd[Ctrl] + :kbd[K] to open search.
21
+ Press :kbd[Ctrl + K] to open search.
22
22
 
23
23
  ```md
24
- Press :kbd[Ctrl] + :kbd[K] to open search.
24
+ Press :kbd[Ctrl + K] to open search.
25
25
  ```
26
26
 
27
+ Use spaces around the separator. RDX shows each key separately and provides a
28
+ single text alternative for assistive technology, using the interface language
29
+ from `lang` in `rdx.config.ts`. The English alternative for this example is
30
+ "Control plus K"; in Brazilian Portuguese it is "Control mais K".
31
+
32
+ Multiple modifiers and the plus key work the same way:
33
+
34
+ :kbd[Ctrl + Shift + P] or :kbd[Ctrl + +].
35
+
36
+ ```md
37
+ :kbd[Ctrl + Shift + P] or :kbd[Ctrl + +].
38
+ ```
39
+
40
+ Write individual keys separately when they describe independent actions:
41
+ :kbd[Enter] to confirm and :kbd[Esc] to close.
42
+
27
43
  ## Shortcut reference tables
28
44
 
29
- | Action | Shortcut |
30
- | :------------- | :------------------- |
31
- | Open search | :kbd[Ctrl] + :kbd[K] |
32
- | Save | :kbd[Ctrl] + :kbd[S] |
33
- | Close a dialog | :kbd[Esc] |
45
+ | Action | Shortcut |
46
+ | :------------- | :------------- |
47
+ | Open search | :kbd[Ctrl + K] |
48
+ | Save | :kbd[Ctrl + S] |
49
+ | Close a dialog | :kbd[Esc] |
34
50
 
35
51
  ```md
36
- | Action | Shortcut |
37
- | :------------- | :------------------- |
38
- | Open search | :kbd[Ctrl] + :kbd[K] |
39
- | Save | :kbd[Ctrl] + :kbd[S] |
40
- | Close a dialog | :kbd[Esc] |
52
+ | Action | Shortcut |
53
+ | :------------- | :------------- |
54
+ | Open search | :kbd[Ctrl + K] |
55
+ | Save | :kbd[Ctrl + S] |
56
+ | Close a dialog | :kbd[Esc] |
41
57
  ```
42
58
 
43
59
  These shared shadcn/ui components render semantic `<kbd>` elements and follow
package/templates/default/package.json CHANGED
@@ -9,7 +9,7 @@
9
9
  "start": "rdx start"
10
10
  },
11
11
  "dependencies": {
12
- "@lexibase/rdx": "3.1.0",
12
+ "@lexibase/rdx": "4.0.0",
13
13
  "next": "^16.4.2",
14
14
  "react": "19.3.1",
15
15
  "react-dom": "19.3.1"
package/templates/default/rdx.config.ts CHANGED
@@ -10,7 +10,8 @@ export default defineConfig({
10
10
  applicationName: 'My documentation',
11
11
  // Footer starting year. Change it to an earlier founding year if needed.
12
12
  since: new Date().getFullYear(),
13
- // Set metadataBase to your public site URL to resolve relative share images.
13
+ // Set metadataBase to your public site URL for the sitemap and share images.
14
+ // metadataBase: 'https://docs.example.com',
14
15
  // Optional examples below: uncomment only after adding the referenced files.
15
16
  // icons: {
16
17
  // icon: [