Skip to content

Commit 99782bf

Browse files
committed
added cards
1 parent 3bd88b2 commit 99782bf

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

docs/mini-apps/core-concepts/manifest.mdx

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Changes to the manifest take effect when you redeploy your Mini App and repost i
6464
### accountAssociation
6565

6666
Proves domain ownership for your Mini App.
67-
67+
<Card>
6868
<ParamField path="header" type="string" required>
6969
Encoded header for the association payload.
7070
</ParamField>
@@ -84,13 +84,14 @@ This verifies ownership and connects your Base Build account.This address should
8484
<ParamField path="allowedAddresses" type="string" required>
8585
This verifies ownership and connects your Base Build account.
8686
</ParamField>
87-
87+
</Card>
8888

8989

9090
#### Identity & Launch
9191

9292
Defines your Mini App's core identity and the URL users land on when they open it.
9393

94+
<Card>
9495
<ParamField path="version" type="string" required>
9596
Manifest version. Must be `"1"`.
9697
</ParamField>
@@ -106,23 +107,27 @@ Default launch URL. HTTPS URL, max 1024 chars.
106107
<ParamField path="iconUrl" type="string" required>
107108
Icon image URL. HTTPS URL, PNG 1024×1024; transparent background discouraged.
108109
</ParamField>
110+
</Card>
109111

110112
#### Loading Experience
111113

112114
Controls the splash screen visuals and colors shown while your Mini App loads.
113115

116+
<Card>
114117
<ParamField path="splashImageUrl" type="string" required>
115118
Loading image. HTTPS URL, recommended 200×200px.
116119
</ParamField>
117120

118121
<ParamField path="splashBackgroundColor" type="string" required>
119122
Loading background color. Hex code (e.g., `#000000`).
120123
</ParamField>
124+
</Card>
121125

122126
#### Discovery & Search
123127

124128
Determines how your Mini App is indexed, categorized, and surfaced across Base App discovery features.
125129

130+
<Card>
126131
<ParamField path="primaryCategory" type="string" required>
127132
Controls where your app appears in category browsing. One of: `games`, `social`, `finance`, `utility`, `productivity`, `health-fitness`, `news-media`, `music`, `shopping`, `education`, `developer-tools`, `entertainment`, `art-creativity`.
128133
</ParamField>
@@ -134,11 +139,13 @@ Search/filter tags. Up to 5; ≤ 20 chars each; lowercase; no spaces/emojis/spec
134139
<ParamField path="noindex" type="boolean">
135140
Exclude from search results. `true` = exclude, default = include.
136141
</ParamField>
142+
</Card>
137143

138144
#### Display Information
139145

140146
Provides the descriptive text, screenshots, and promotional images shown on your Mini App's profile.
141147

148+
<Card>
142149
<ParamField path="subtitle" type="string">
143150
Short description under name. Max 30 chars; avoid emojis/special chars.
144151
</ParamField>
@@ -158,11 +165,22 @@ Large promo image. 1200×630px (1.91:1), PNG/JPG.
158165
<ParamField path="screenshotUrls" type="string[]">
159166
Visual previews. Max 3; portrait 1284×2778px recommended.
160167
</ParamField>
168+
</Card>
169+
170+
#### Notifications
171+
172+
Notification endpoint.
173+
<Card>
174+
<ParamField path="webhookUrl" type="string">
175+
POST events endpoint. HTTPS URL, max 1024 chars. Required if using notifications.
176+
</ParamField>
177+
</Card>
161178

162179
#### Embeds & Social Sharing
163180

164181
Configures how your Mini App appears when shared in feeds or on social platforms.
165182

183+
<Card>
166184
<ParamField path="ogTitle" type="string">
167185
Open Graph title. Max 30 chars.
168186
</ParamField>
@@ -174,14 +192,9 @@ Open Graph description. Max 100 chars.
174192
<ParamField path="ogImageUrl" type="string">
175193
Open Graph image. 1200×630px (1.91:1), PNG/JPG.
176194
</ParamField>
195+
</Card>
177196

178-
#### Notifications
179-
180-
Notification endpoint.
181197

182-
<ParamField path="webhookUrl" type="string">
183-
POST events endpoint. HTTPS URL, max 1024 chars. Required if using notifications.
184-
</ParamField>
185198

186199
## Related Concepts
187200

0 commit comments

Comments
 (0)