Skip to content

docs: migrate docs site to rspress #5004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adamTrz wants to merge 18 commits into
base: main
Choose a base branch
from
Open

docs: migrate docs site to rspress #5004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
0294677
migrate docs site to rspress
adamTrz Jun 17, 2026
bd8572d
align homepage content edges
adamTrz Jun 17, 2026
10329e6
docs: fix rspress docs lint checks
adamTrz Jun 17, 2026
2efcfe9
docs: fix rspress migration follow-ups
adamTrz Jun 17, 2026
e0c2214
docs: remove local playwright visual checks
adamTrz Jun 18, 2026
c555f49
docs: remove stale docusaurus files
adamTrz Jun 22, 2026
da70d0a
docs: remove stale babel config
adamTrz Jun 22, 2026
f9a7962
docs: keep generated component docs as ts modules
adamTrz Jun 22, 2026
acabdf4
docs: generate component metadata as json
adamTrz Jun 22, 2026
e26990e
style: format component docs generator
adamTrz Jun 22, 2026
a7bf5ad
fix: make component docs generator ts-compatible
adamTrz Jun 22, 2026
7650554
fix: run docs generator without strip-types
adamTrz Jun 22, 2026
7da93f2
style: satisfy prettier in docs generator
adamTrz Jun 22, 2026
c928ed0
Fix docs client-side navigation
adamTrz Jun 22, 2026
0ed99a6
Remove duplicated versioned docs sources
adamTrz Jun 22, 2026
2edea79
Merge branch 'main' of github.com:callstack/react-native-paper into a…
satya164 Jun 22, 2026
6b48f0e
Fix docs version selector navbar placement
adamTrz Jun 23, 2026
776efb5
Fix docs test formatting
adamTrz Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Production
/build
/test-results
/visual/output

# Generated files
.docusaurus
.cache-loader
/public/llms.txt
/public/react-native-paper

# Misc
.DS_Store
Expand Down
17 changes: 17 additions & 0 deletions docs/5.x/_nav.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[
{
"text": "Guides",
"link": "/docs/guides/getting-started",
"activeMatch": "^/docs/guides/"
},
{
"text": "Components",
"link": "/docs/components/ActivityIndicator",
"activeMatch": "^/docs/components/"
},
{
"text": "Showcase",
"link": "/docs/showcase",
"activeMatch": "^/docs/showcase$"
}
]
17 changes: 17 additions & 0 deletions docs/5.x/docs/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[
{
"type": "dir-section-header",
"name": "guides",
"label": "Guides"
},
{
"type": "dir-section-header",
"name": "components",
"label": "Components"
},
{
"type": "file",
"name": "showcase",
"label": "Showcase"
}
]
12 changes: 6 additions & 6 deletions ...sion-5.x/components/ActivityIndicator.mdx → ...5.x/docs/components/ActivityIndicator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,47 +41,47 @@ export default MyComponent;

</div>

<PropTable componentLink="ActivityIndicator" prop="animating" />
<PropTable componentLink="ActivityIndicator" prop="animating" version="5.x" />

<div>

### color

</div>

<PropTable componentLink="ActivityIndicator" prop="color" />
<PropTable componentLink="ActivityIndicator" prop="color" version="5.x" />

<div>

### size

</div>

<PropTable componentLink="ActivityIndicator" prop="size" />
<PropTable componentLink="ActivityIndicator" prop="size" version="5.x" />

<div>

### hidesWhenStopped

</div>

<PropTable componentLink="ActivityIndicator" prop="hidesWhenStopped" />
<PropTable componentLink="ActivityIndicator" prop="hidesWhenStopped" version="5.x" />

<div>

### style

</div>

<PropTable componentLink="ActivityIndicator" prop="style" />
<PropTable componentLink="ActivityIndicator" prop="style" version="5.x" />

<div>

### theme

</div>

<PropTable componentLink="ActivityIndicator" prop="theme" />
<PropTable componentLink="ActivityIndicator" prop="theme" version="5.x" />



Expand Down
14 changes: 7 additions & 7 deletions .../version-5.x/components/Appbar/Appbar.mdx → docs/5.x/docs/components/Appbar/Appbar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,55 +111,55 @@ export default MyComponent;

</div>

<PropTable componentLink="Appbar/Appbar" prop="dark" />
<PropTable componentLink="Appbar/Appbar" prop="dark" version="5.x" />

<div>

### children (required)

</div>

<PropTable componentLink="Appbar/Appbar" prop="children" />
<PropTable componentLink="Appbar/Appbar" prop="children" version="5.x" />

<div>

### mode <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>

</div>

<PropTable componentLink="Appbar/Appbar" prop="mode" />
<PropTable componentLink="Appbar/Appbar" prop="mode" version="5.x" />

<div>

### elevated <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>

</div>

<PropTable componentLink="Appbar/Appbar" prop="elevated" />
<PropTable componentLink="Appbar/Appbar" prop="elevated" version="5.x" />

<div>

### safeAreaInsets

</div>

<PropTable componentLink="Appbar/Appbar" prop="safeAreaInsets" />
<PropTable componentLink="Appbar/Appbar" prop="safeAreaInsets" version="5.x" />

<div>

### theme

</div>

<PropTable componentLink="Appbar/Appbar" prop="theme" />
<PropTable componentLink="Appbar/Appbar" prop="theme" version="5.x" />

<div>

### style

</div>

<PropTable componentLink="Appbar/Appbar" prop="style" />
<PropTable componentLink="Appbar/Appbar" prop="style" version="5.x" />



Expand Down
22 changes: 11 additions & 11 deletions ...on-5.x/components/Appbar/AppbarAction.mdx → ...x/docs/components/Appbar/AppbarAction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,87 +47,87 @@ export default MyComponent;

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="color" />
<PropTable componentLink="Appbar/AppbarAction" prop="color" version="5.x" />

<div>

### rippleColor

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="rippleColor" />
<PropTable componentLink="Appbar/AppbarAction" prop="rippleColor" version="5.x" />

<div>

### icon (required)

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="icon" />
<PropTable componentLink="Appbar/AppbarAction" prop="icon" version="5.x" />

<div>

### size

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="size" />
<PropTable componentLink="Appbar/AppbarAction" prop="size" version="5.x" />

<div>

### disabled

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="disabled" />
<PropTable componentLink="Appbar/AppbarAction" prop="disabled" version="5.x" />

<div>

### accessibilityLabel

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="accessibilityLabel" />
<PropTable componentLink="Appbar/AppbarAction" prop="accessibilityLabel" version="5.x" />

<div>

### onPress

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="onPress" />
<PropTable componentLink="Appbar/AppbarAction" prop="onPress" version="5.x" />

<div>

### isLeading <span class="badge badge-supported "><span class="badge-text">Available in v5.x with theme version 3</span></span>

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="isLeading" />
<PropTable componentLink="Appbar/AppbarAction" prop="isLeading" version="5.x" />

<div>

### style

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="style" />
<PropTable componentLink="Appbar/AppbarAction" prop="style" version="5.x" />

<div>

### ref

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="ref" />
<PropTable componentLink="Appbar/AppbarAction" prop="ref" version="5.x" />

<div>

### theme

</div>

<PropTable componentLink="Appbar/AppbarAction" prop="theme" />
<PropTable componentLink="Appbar/AppbarAction" prop="theme" version="5.x" />



Expand Down
14 changes: 7 additions & 7 deletions ....x/components/Appbar/AppbarBackAction.mdx → ...cs/components/Appbar/AppbarBackAction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,55 +42,55 @@ export default MyComponent;

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="color" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="color" version="5.x" />

<div>

### size

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="size" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="size" version="5.x" />

<div>

### disabled

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="disabled" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="disabled" version="5.x" />

<div>

### accessibilityLabel

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="accessibilityLabel" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="accessibilityLabel" version="5.x" />

<div>

### onPress

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="onPress" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="onPress" version="5.x" />

<div>

### style

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="style" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="style" version="5.x" />

<div>

### ref

</div>

<PropTable componentLink="Appbar/AppbarBackAction" prop="ref" />
<PropTable componentLink="Appbar/AppbarBackAction" prop="ref" version="5.x" />



Expand Down
Loading
Loading