Skip to content

Commit c875ad5

Browse files
docs: add highlight prop to snippet component documentation (#2945)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Fern Support <[email protected]>
1 parent fbcd4d6 commit c875ad5

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,17 @@ your API Reference.
7474
If the example includes a `summary` or `docs` field, use that for the `example` prop. If not summary is set, use the example name.
7575
</Note>
7676
</Steps>
77+
78+
## Properties
79+
80+
<ParamField path="endpoint" type="string" required={true}>
81+
The endpoint to display, in the format `METHOD /path` (e.g., `POST /chat/{domain}`).
82+
</ParamField>
83+
84+
<ParamField path="example" type="string" required={false}>
85+
The name of a specific example to display. If the example includes a `summary` or `docs` field, use that value.
86+
</ParamField>
87+
88+
<ParamField path="highlight" type="number | number[]" required={false}>
89+
Line numbers to highlight in the code snippet. Accepts a single number, an array of numbers, or ranges (e.g., `{[1-3, 5]}`).
90+
</ParamField>

fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,17 @@ your API Reference.
7474
/>
7575
```
7676
</Steps>
77+
78+
## Properties
79+
80+
<ParamField path="endpoint" type="string" required={true}>
81+
The endpoint to display, in the format `METHOD /path` (e.g., `POST /chat/{domain}`).
82+
</ParamField>
83+
84+
<ParamField path="example" type="string" required={false}>
85+
The name of a specific example to display. If the example includes a `summary` or `docs` field, use that value.
86+
</ParamField>
87+
88+
<ParamField path="highlight" type="number | number[]" required={false}>
89+
Line numbers to highlight in the code snippet. Accepts a single number, an array of numbers, or ranges (e.g., `{[1-3, 5]}`).
90+
</ParamField>

fern/products/docs/pages/component-library/default-components/schema-snippet.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,7 @@ Use `<SchemaSnippet>` alongside `<Schema>` to display both the JSON representati
5353
<ParamField path="className" type="string" required={false}>
5454
Optional CSS class name for custom styling.
5555
</ParamField>
56+
57+
<ParamField path="highlight" type="number | number[]" required={false}>
58+
Line numbers to highlight in the code snippet. Accepts a single number, an array of numbers, or ranges (e.g., `{[1-3, 5]}`).
59+
</ParamField>

0 commit comments

Comments
 (0)