@lexibase/create-rdx 1.0.0-beta.7 → 1.0.0-beta.9
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 +2 -2
- package/templates/default/README.md +16 -0
- package/templates/default/docs/examples/accordion.mdx +69 -0
- package/templates/default/docs/examples/callouts.mdx +56 -0
- package/templates/default/docs/examples/links.mdx +38 -0
- package/templates/default/docs/examples/markdown.mdx +47 -0
- package/templates/default/docs/examples/tabs.mdx +72 -0
- package/templates/default/package.json +8 -8
- package/templates/default/rdx.config.ts +2 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lexibase/create-rdx",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.9",
|
|
4
4
|
"description": "Create a new RDX documentation project.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"bin": {
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"README.md"
|
|
14
14
|
],
|
|
15
15
|
"engines": {
|
|
16
|
-
"node": ">=
|
|
16
|
+
"node": ">=20.9"
|
|
17
17
|
},
|
|
18
18
|
"publishConfig": {
|
|
19
19
|
"access": "public"
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
This documentation site was created with RDX.
|
|
4
4
|
|
|
5
|
+
Requires Node.js 20.9 or newer. Use a currently supported Node.js LTS release.
|
|
6
|
+
|
|
5
7
|
## Development
|
|
6
8
|
|
|
7
9
|
```bash
|
|
@@ -11,6 +13,20 @@ pnpm dev
|
|
|
11
13
|
Edit files in `docs/` to create your documentation. RDX creates and maintains
|
|
12
14
|
its internal runtime in `.rdx/`.
|
|
13
15
|
|
|
16
|
+
## Optional versioning
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pnpm rdx add versioning
|
|
20
|
+
pnpm rdx version 1.0.0
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The first command installs the official plugin, activates it in `rdx.config.ts`
|
|
24
|
+
and prepares the runtime. It preserves existing options and validates the
|
|
25
|
+
configuration before saving it, without creating backup files. Restart `pnpm dev` afterward. Repeated
|
|
26
|
+
activation does not duplicate the plugin or upgrade its installed version.
|
|
27
|
+
If the configuration is too dynamic to edit safely, follow the manual
|
|
28
|
+
instructions printed by the CLI. Installing a package alone does not activate it.
|
|
29
|
+
|
|
14
30
|
## Public files
|
|
15
31
|
|
|
16
32
|
Put images and downloads in the project-root `public/` folder:
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Accordion
|
|
3
|
+
description: Keep optional explanations close without crowding the page.
|
|
4
|
+
link_position: 6
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Frequently asked questions
|
|
8
|
+
|
|
9
|
+
Use Enter or Space to expand an item. Tab moves between questions and links.
|
|
10
|
+
One item opens at a time; selecting it again closes it.
|
|
11
|
+
|
|
12
|
+
<Accordion>
|
|
13
|
+
<AccordionItem value="content">
|
|
14
|
+
<AccordionTrigger>Where do I write my documentation?</AccordionTrigger>
|
|
15
|
+
<AccordionContent>
|
|
16
|
+
|
|
17
|
+
Create folders and `.mdx` files inside **docs/**. Each folder becomes a category
|
|
18
|
+
and each file becomes a page.
|
|
19
|
+
|
|
20
|
+
Read the [introduction](/docs/init/intro) to get started.
|
|
21
|
+
|
|
22
|
+
</AccordionContent>
|
|
23
|
+
</AccordionItem>
|
|
24
|
+
<AccordionItem value="preview">
|
|
25
|
+
<AccordionTrigger>How do I preview my changes?</AccordionTrigger>
|
|
26
|
+
<AccordionContent>
|
|
27
|
+
|
|
28
|
+
Run the development server:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pnpm dev
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
<Callout variant="tip" title="Live updates">
|
|
35
|
+
|
|
36
|
+
Keep the server running while editing your documentation.
|
|
37
|
+
|
|
38
|
+
</Callout>
|
|
39
|
+
|
|
40
|
+
</AccordionContent>
|
|
41
|
+
</AccordionItem>
|
|
42
|
+
<AccordionItem value="soon" disabled>
|
|
43
|
+
<AccordionTrigger>More examples (soon)</AccordionTrigger>
|
|
44
|
+
<AccordionContent>Not available yet.</AccordionContent>
|
|
45
|
+
</AccordionItem>
|
|
46
|
+
</Accordion>
|
|
47
|
+
|
|
48
|
+
## Production checklist
|
|
49
|
+
|
|
50
|
+
Opening an answer closes the previous one in the same group.
|
|
51
|
+
|
|
52
|
+
<Accordion>
|
|
53
|
+
<AccordionItem value="build">
|
|
54
|
+
<AccordionTrigger>Build for production</AccordionTrigger>
|
|
55
|
+
<AccordionContent>
|
|
56
|
+
|
|
57
|
+
Run `pnpm build` to generate the production site.
|
|
58
|
+
|
|
59
|
+
</AccordionContent>
|
|
60
|
+
</AccordionItem>
|
|
61
|
+
<AccordionItem value="start">
|
|
62
|
+
<AccordionTrigger>Check the production site</AccordionTrigger>
|
|
63
|
+
<AccordionContent>
|
|
64
|
+
|
|
65
|
+
Run `pnpm start` after a successful build.
|
|
66
|
+
|
|
67
|
+
</AccordionContent>
|
|
68
|
+
</AccordionItem>
|
|
69
|
+
</Accordion>
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Callouts
|
|
3
|
+
description: Highlight notes, tips and important information.
|
|
4
|
+
link_position: 4
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Highlight important information
|
|
8
|
+
|
|
9
|
+
Callouts are included in RDX. No import or plugin is required.
|
|
10
|
+
|
|
11
|
+
<Callout title="A useful note">
|
|
12
|
+
|
|
13
|
+
Keep supporting information close to the documentation it explains.
|
|
14
|
+
|
|
15
|
+
</Callout>
|
|
16
|
+
|
|
17
|
+
<Callout variant="tip" title="A helpful tip">
|
|
18
|
+
|
|
19
|
+
You can use **Markdown**, [documentation links](/docs/init/intro), and `inline code` inside a callout.
|
|
20
|
+
|
|
21
|
+
</Callout>
|
|
22
|
+
|
|
23
|
+
<Callout variant="success" title="Ready to go">
|
|
24
|
+
|
|
25
|
+
Your documentation is ready to share.
|
|
26
|
+
|
|
27
|
+
</Callout>
|
|
28
|
+
|
|
29
|
+
<Callout variant="warning" title="Before updating">
|
|
30
|
+
|
|
31
|
+
- Read the release notes.
|
|
32
|
+
- Test your changes before deploying.
|
|
33
|
+
|
|
34
|
+
</Callout>
|
|
35
|
+
|
|
36
|
+
<Callout variant="danger" title="Irreversible action">
|
|
37
|
+
|
|
38
|
+
Deleting the source files permanently removes their content.
|
|
39
|
+
|
|
40
|
+
</Callout>
|
|
41
|
+
|
|
42
|
+
<Callout>
|
|
43
|
+
|
|
44
|
+
A title is optional. The default variant is `note`.
|
|
45
|
+
|
|
46
|
+
</Callout>
|
|
47
|
+
|
|
48
|
+
## Syntax
|
|
49
|
+
|
|
50
|
+
```mdx
|
|
51
|
+
<Callout variant="warning" title="Before updating">
|
|
52
|
+
|
|
53
|
+
Test your changes before deploying.
|
|
54
|
+
|
|
55
|
+
</Callout>
|
|
56
|
+
```
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Document links
|
|
3
|
+
description: Link to documentation files using their relative paths.
|
|
4
|
+
link_position: 7
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Link to a page
|
|
8
|
+
|
|
9
|
+
Read the [introduction](../init/intro.mdx) or learn how to
|
|
10
|
+
[create a page](../init/getting-started.mdx#create-a-page).
|
|
11
|
+
|
|
12
|
+
```md
|
|
13
|
+
[Introduction](../init/intro.mdx)
|
|
14
|
+
[Create a page](../init/getting-started.mdx#create-a-page)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
RDX resolves these paths relative to this file. When viewing a snapshot,
|
|
18
|
+
links stay inside that snapshot instead of switching to Current.
|
|
19
|
+
|
|
20
|
+
## Link to a section
|
|
21
|
+
|
|
22
|
+
Jump to the [tables example](./markdown.mdx#tables), or return to
|
|
23
|
+
[the first section](#link-to-a-page) of this page.
|
|
24
|
+
|
|
25
|
+
Markdown headings receive automatic IDs. Repeated headings get suffixes such as
|
|
26
|
+
`tables-1`. Relative document links must include the `.mdx` extension.
|
|
27
|
+
|
|
28
|
+
<Callout title="Keep links portable">
|
|
29
|
+
|
|
30
|
+
Use forward slashes and match the file's name and capitalization. If a destination
|
|
31
|
+
does not exist in the current version, RDX reports the source file and link to fix.
|
|
32
|
+
|
|
33
|
+
</Callout>
|
|
34
|
+
|
|
35
|
+
## Assets and external links
|
|
36
|
+
|
|
37
|
+
[External links](https://example.com/), `/images/logo.svg` and paths to downloads
|
|
38
|
+
are not rewritten. Put public assets in `public/` and reference them from `/`.
|
|
@@ -13,3 +13,50 @@ link_position: 1
|
|
|
13
13
|
```ts
|
|
14
14
|
const framework = 'RDX'
|
|
15
15
|
```
|
|
16
|
+
|
|
17
|
+
## Tables
|
|
18
|
+
|
|
19
|
+
| Feature | Available |
|
|
20
|
+
| :------ | --------: |
|
|
21
|
+
| Markdown tables | Yes |
|
|
22
|
+
| Callouts | Yes |
|
|
23
|
+
| Code blocks | Yes |
|
|
24
|
+
| Blockquotes | Yes |
|
|
25
|
+
|
|
26
|
+
### Five-column comparison
|
|
27
|
+
|
|
28
|
+
Wider tables scroll horizontally on small screens without widening the page.
|
|
29
|
+
|
|
30
|
+
| Feature | Description | Status | Plugin | Example |
|
|
31
|
+
| :------ | :---------- | :----: | :----: | :------ |
|
|
32
|
+
| Markdown | Write headings, lists, and paragraphs | Included | Not required | `## Heading` |
|
|
33
|
+
| Callout | Highlight contextual information | Included | Not required | `<Callout>` |
|
|
34
|
+
| Code block | Display source code with a copy button | Included | Not required | `pnpm dev` |
|
|
35
|
+
| Blockquote | Quote a passage or explanation | Included | Not required | `> A quotation` |
|
|
36
|
+
|
|
37
|
+
## Task lists
|
|
38
|
+
|
|
39
|
+
- [x] Create a documentation project
|
|
40
|
+
- [ ] Add your own pages
|
|
41
|
+
|
|
42
|
+
> Keep explanations close to the content they describe.
|
|
43
|
+
>
|
|
44
|
+
> A quotation can contain **formatted text**, [links](/docs/init/intro), and `inline code`.
|
|
45
|
+
|
|
46
|
+
You can also use ~~strikethrough~~ text.
|
|
47
|
+
|
|
48
|
+
## Syntax highlighting
|
|
49
|
+
|
|
50
|
+
Put the language after the opening fence, such as `tsx`, `json`, `bash`, `py`
|
|
51
|
+
or `css`. Colors follow your site's light/dark theme automatically. Unlabelled
|
|
52
|
+
or unknown languages remain readable as plain text.
|
|
53
|
+
|
|
54
|
+
```tsx
|
|
55
|
+
export function Welcome() {
|
|
56
|
+
return <h1>Welcome to RDX</h1>
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{ "framework": "RDX", "minimal": true }
|
|
62
|
+
```
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Tabs
|
|
3
|
+
description: Group related examples without leaving the page.
|
|
4
|
+
link_position: 5
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Choose your package manager
|
|
8
|
+
|
|
9
|
+
Tabs are included in RDX. No import or plugin is required.
|
|
10
|
+
Use the arrow keys to move between tabs and Enter or Space to select one.
|
|
11
|
+
|
|
12
|
+
<Tabs defaultValue="pnpm">
|
|
13
|
+
<TabsList aria-label="Package manager">
|
|
14
|
+
<TabsTrigger value="npm">npm</TabsTrigger>
|
|
15
|
+
<TabsTrigger value="pnpm">pnpm</TabsTrigger>
|
|
16
|
+
<TabsTrigger value="yarn">yarn</TabsTrigger>
|
|
17
|
+
</TabsList>
|
|
18
|
+
<TabsContent value="npm">
|
|
19
|
+
|
|
20
|
+
Install dependencies with **npm**:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
</TabsContent>
|
|
27
|
+
<TabsContent value="pnpm">
|
|
28
|
+
|
|
29
|
+
Install dependencies with **pnpm**:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pnpm install
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
</TabsContent>
|
|
36
|
+
<TabsContent value="yarn">
|
|
37
|
+
|
|
38
|
+
Install dependencies with **yarn**:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
yarn install
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
</TabsContent>
|
|
45
|
+
</Tabs>
|
|
46
|
+
|
|
47
|
+
## Keep related information together
|
|
48
|
+
|
|
49
|
+
Each group works independently. Panels can contain normal Markdown and RDX components.
|
|
50
|
+
|
|
51
|
+
<Tabs defaultValue="development">
|
|
52
|
+
<TabsList aria-label="Environment">
|
|
53
|
+
<TabsTrigger value="development">Development</TabsTrigger>
|
|
54
|
+
<TabsTrigger value="production">Production</TabsTrigger>
|
|
55
|
+
<TabsTrigger value="preview" disabled>Preview (soon)</TabsTrigger>
|
|
56
|
+
</TabsList>
|
|
57
|
+
<TabsContent value="development">
|
|
58
|
+
|
|
59
|
+
<Callout variant="tip" title="Live updates">
|
|
60
|
+
|
|
61
|
+
Run `pnpm dev` and edit your documentation to see changes locally.
|
|
62
|
+
|
|
63
|
+
</Callout>
|
|
64
|
+
|
|
65
|
+
</TabsContent>
|
|
66
|
+
<TabsContent value="production">
|
|
67
|
+
|
|
68
|
+
1. Run `pnpm build`.
|
|
69
|
+
2. Run `pnpm start` to check the production site.
|
|
70
|
+
|
|
71
|
+
</TabsContent>
|
|
72
|
+
</Tabs>
|
|
@@ -9,18 +9,18 @@
|
|
|
9
9
|
"start": "rdx start"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@lexibase/rdx-ui": "
|
|
13
|
-
"@lexibase/rdx-next": "
|
|
14
|
-
"next": "^
|
|
15
|
-
"react": "19.1
|
|
16
|
-
"react-dom": "19.1
|
|
12
|
+
"@lexibase/rdx-ui": "1.0.0-beta.2",
|
|
13
|
+
"@lexibase/rdx-next": "1.0.0-beta.10",
|
|
14
|
+
"next": "^16.4.2",
|
|
15
|
+
"react": "19.3.1",
|
|
16
|
+
"react-dom": "19.3.1"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
19
|
"@types/node": "^22.15.3",
|
|
20
|
-
"@types/react": "19.
|
|
21
|
-
"typescript": "
|
|
20
|
+
"@types/react": "19.3.0",
|
|
21
|
+
"typescript": "6.0.3"
|
|
22
22
|
},
|
|
23
23
|
"engines": {
|
|
24
|
-
"node": ">=
|
|
24
|
+
"node": ">=20.9"
|
|
25
25
|
}
|
|
26
26
|
}
|