@lexibase/create-rdx 1.2.2 → 2.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lexibase/create-rdx",
3
- "version": "1.2.2",
3
+ "version": "2.0.0",
4
4
  "description": "Create a new RDX documentation project.",
5
5
  "license": "MIT",
6
6
  "bin": {
@@ -16,6 +16,9 @@ pnpm dev
16
16
 
17
17
  Edit files in `docs/` to create your documentation. RDX creates and maintains
18
18
  its internal runtime in `.rdx/`.
19
+ Keep custom React components in `components/` and import them from
20
+ `rdx.config.ts` or `components/home.tsx`. The project-root `tsconfig.json` configures JSX
21
+ and bundler-style imports for these files, including inside a monorepo.
19
22
  If installation failed during creation, keep these files, fix the reported error
20
23
  and retry `pnpm install` (or `npm install` / `yarn install`) before starting.
21
24
 
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: Keyboard shortcuts
3
+ description: Display keys and shortcut combinations with Kbd.
4
+ link_position: 8
5
+ ---
6
+
7
+ ## Single keys
8
+
9
+ Press <Kbd>Enter</Kbd> to confirm or <Kbd>Esc</Kbd> to close a dialog.
10
+
11
+ ## Shortcut reference
12
+
13
+ Use `KbdGroup` to keep keys together when describing your application's shortcuts:
14
+
15
+ | Action | Shortcut |
16
+ | :----- | :------- |
17
+ | Search | <KbdGroup><Kbd>Ctrl</Kbd>+<Kbd>K</Kbd></KbdGroup> |
18
+ | Save | <KbdGroup><Kbd>Ctrl</Kbd>+<Kbd>S</Kbd></KbdGroup> |
19
+ | Close | <Kbd>Esc</Kbd> |
20
+
21
+ ```mdx
22
+ <KbdGroup aria-label="Control plus K">
23
+ <Kbd>Ctrl</Kbd>+<Kbd>K</Kbd>
24
+ </KbdGroup>
25
+ ```
26
+
27
+ For a macOS shortcut:
28
+
29
+ <KbdGroup aria-label="Command plus K">
30
+ <Kbd aria-label="Command">⌘</Kbd>+<Kbd>K</Kbd>
31
+ </KbdGroup>
@@ -9,7 +9,7 @@
9
9
  "start": "rdx start"
10
10
  },
11
11
  "dependencies": {
12
- "@lexibase/rdx": "1.2.1",
12
+ "@lexibase/rdx": "2.0.0",
13
13
  "next": "^16.4.2",
14
14
  "react": "19.3.1",
15
15
  "react-dom": "19.3.1"
@@ -2,6 +2,8 @@ import { defineConfig } from '@lexibase/rdx'
2
2
 
3
3
  export default defineConfig({
4
4
  description: 'Documentation built with RDX.',
5
+ // HTML and interface language: 'en' or 'pt-BR'. Your documents stay as written.
6
+ lang: 'en',
5
7
  // Site identity, SEO and link previews. '/' paths refer to files in public/.
6
8
  metadata: {
7
9
  // The single site name: browser titles, social previews and default branding.
@@ -39,7 +41,7 @@ export default defineConfig({
39
41
  },
40
42
  },
41
43
  // When disabled, '/' redirects to '/docs'.
42
- // To use your own home.tsx, import its component and set homepage.component.
44
+ // Import your components/home.tsx and set homepage.component to use a custom page.
43
45
  homepage: {
44
46
  enabled: false,
45
47
  },
@@ -0,0 +1,18 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "lib": ["dom", "dom.iterable", "esnext"],
5
+ "module": "esnext",
6
+ "moduleResolution": "bundler",
7
+ "jsx": "react-jsx",
8
+ "types": ["node", "react"],
9
+ "esModuleInterop": true,
10
+ "resolveJsonModule": true,
11
+ "isolatedModules": true,
12
+ "strict": true,
13
+ "skipLibCheck": true,
14
+ "noEmit": true
15
+ },
16
+ "include": ["**/*.ts", "**/*.tsx"],
17
+ "exclude": ["node_modules", ".rdx"]
18
+ }