Skip to content

Commit 570e48b

Browse files
committed
example formatting
1 parent c4ec583 commit 570e48b

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

guides/cursor.mdx

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,39 +66,40 @@ You are an AI writing assistant specialized in creating exceptional technical do
6666
6767
### Callout components
6868
69-
**Note - Additional helpful information:**
69+
#### Note - Additional helpful information
7070
7171
<Note>
7272
Supplementary information that supports the main content without interrupting flow
7373
</Note>
7474
75-
**Tip - Best practices and pro tips:**
75+
#### Tip - Best practices and pro tips
7676
7777
<Tip>
7878
Expert advice, shortcuts, or best practices that enhance user success
7979
</Tip>
8080
81-
**Warning - Important cautions:**
81+
#### Warning - Important cautions
8282
8383
<Warning>
8484
Critical information about potential issues, breaking changes, or destructive actions
8585
</Warning>
8686
87-
**Info - Neutral contextual information:**
87+
#### Info - Neutral contextual information
8888
8989
<Info>
9090
Background information, context, or neutral announcements
9191
</Info>
9292
93-
**Check - Success confirmations:**
93+
#### Check - Success confirmations
9494
9595
<Check>
9696
Positive confirmations, successful completions, or achievement indicators
9797
</Check>
9898
9999
### Code components
100100
101-
**Single code block:**
101+
#### Single code block
102+
102103
```javascript config.js
103104
const apiConfig = {
104105
baseURL: 'https://api.example.com',
@@ -109,7 +110,8 @@ headers: {
109110
};
110111
```
111112
112-
**Code group with multiple languages:**
113+
#### Code group with multiple languages
114+
113115
<CodeGroup>
114116
```javascript Node.js
115117
const response = await fetch('/api/endpoint', {
@@ -129,7 +131,7 @@ curl -X GET '/api/endpoint' \
129131
```
130132
</CodeGroup>
131133
132-
**Request/Response examples:**
134+
#### Request/Response examples
133135
134136
<RequestExample>
135137
```bash cURL
@@ -152,7 +154,7 @@ curl -X POST 'https://api.example.com/users' \
152154
153155
### Structural components
154156
155-
**Steps for procedures:**
157+
#### Steps for procedures
156158
157159
<Steps>
158160
<Step title="Install dependencies">
@@ -176,7 +178,7 @@ curl -X POST 'https://api.example.com/users' \
176178
</Step>
177179
</Steps>
178180
179-
**Tabs for alternative content:**
181+
#### Tabs for alternative content
180182
181183
<Tabs>
182184
<Tab title="macOS">
@@ -201,7 +203,7 @@ curl -X POST 'https://api.example.com/users' \
201203
</Tab>
202204
</Tabs>
203205
204-
**Accordions for collapsible content:**
206+
#### Accordions for collapsible content
205207
206208
<AccordionGroup>
207209
<Accordion title="Troubleshooting connection issues">
@@ -222,7 +224,7 @@ curl -X POST 'https://api.example.com/users' \
222224
223225
### API documentation components
224226
225-
**Parameter fields:**
227+
#### Parameter fields
226228
227229
<ParamField path="user_id" type="string" required>
228230
Unique identifier for the user. Must be a valid UUID v4 format.
@@ -240,7 +242,7 @@ Maximum number of results to return. Range: 1-100.
240242
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
241243
</ParamField>
242244
243-
**Response fields:**
245+
#### Response fields
244246
245247
<ResponseField name="user_id" type="string" required>
246248
Unique identifier assigned to the newly created user.
@@ -254,7 +256,7 @@ ISO 8601 formatted timestamp of when the user was created.
254256
List of permission strings assigned to this user.
255257
</ResponseField>
256258
257-
**Expandable nested fields:**
259+
#### Expandable nested fields
258260
259261
<ResponseField name="user" type="object">
260262
Complete user object with all associated data.
@@ -278,7 +280,7 @@ Complete user object with all associated data.
278280
279281
### Interactive components
280282
281-
**Cards for navigation:**
283+
#### Cards for navigation
282284
283285
<Card title="Getting started guide" icon="rocket" href="/quickstart">
284286
Complete walkthrough from installation to your first API call in under 10 minutes.
@@ -296,7 +298,9 @@ Complete walkthrough from installation to your first API call in under 10 minute
296298
297299
### Media and advanced components
298300
299-
**Frames for images:**
301+
#### Frames for images
302+
303+
Wrap all images in frames.
300304
301305
<Frame>
302306
<img src="/images/dashboard.png" alt="Main dashboard showing analytics overview" />
@@ -306,7 +310,7 @@ Complete walkthrough from installation to your first API call in under 10 minute
306310
<img src="/images/analytics.png" alt="Analytics dashboard with charts" />
307311
</Frame>
308312
309-
**Tooltips and updates:**
313+
#### Tooltips and updates
310314
311315
<Tooltip tip="Application Programming Interface - protocols for building software">
312316
API

0 commit comments

Comments
 (0)