Skip to content

Commit 5be63f1

Browse files
committed
Merge branch 'promptless/document-custom-sections-readme' of https://github.com/fern-api/docs into promptless/document-custom-sections-readme
2 parents 27c1d73 + e3f2f17 commit 5be63f1

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

fern/products/sdks/snippets/readme-options.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ readme:
1010
method: "POST"
1111
path: "/users"
1212
stream: false
13+
customSections:
14+
- title: "Custom Section"
15+
language: "java"
16+
content: |
17+
This is a custom section. Latest package info is {{ group }}:{{ artifact }}:{{ version }}.
18+
- title: "Custom Section"
19+
language: "typescript"
20+
content: |
21+
Custom section for {{ packageName }}
22+
- title: "Another Custom Section"
23+
language: "typescript"
24+
content: |
25+
A second custom section for {{ packageName }}
1326
features:
1427
authentication:
1528
- method: "POST"
@@ -64,4 +77,27 @@ Specifies which endpoint's code snippet to showcase as the primary example in th
6477

6578
<ParamField path="defaultEndpoint.stream" type="boolean" required={false} default="false" toc={true}>
6679
Whether the endpoint is a streaming endpoint. Defaults to `false`.
80+
</ParamField>
81+
82+
### Custom sections
83+
84+
Define a custom section in the generated README for a specific SDK.
85+
86+
<ParamField path="customSections.title" type="string" required={true}>
87+
The title of the custom section as it will appear in the README.
88+
</ParamField>
89+
<ParamField path="customSections.language" type="'java' | 'typescript'" required={true}>
90+
The target SDK language for this section. The custom section will only appear in README files generated for the specified language.
91+
</ParamField>
92+
<ParamField path="customSections.content" type="string" required={true}>
93+
The Markdown content of the custom section. You can use template variables to dynamically insert package names and SDK version numbers.
94+
95+
| Language | Variable | Description |
96+
|----------|----------|-------------|
97+
| Java | `{{ group }}` | Maven groupId from `coordinate` field |
98+
| Java | `{{ artifact }}` | Maven artifactId from `coordinate` field |
99+
| Java | `{{ version }}` | SDK version |
100+
| TypeScript | `{{ packageName }}` | Name of your package, as specified in the `package-name` field |
101+
| TypeScript | `{{ version }}` | SDK version |
102+
67103
</ParamField>

0 commit comments

Comments
 (0)