Skip to content

Commit 0869511

Browse files
devalogdevalog
committed
fix some errors
1 parent 00459fd commit 0869511

File tree

3 files changed

+64
-64
lines changed

3 files changed

+64
-64
lines changed

‎fern/products/sdks/overview/python/quickstart.mdx‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,25 @@ Generate a Python SDK by following the instructions on this page.
2626

2727
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
2828

29-
### Add the SDK generator
29+
### Add the SDK generator
3030

31-
Add the Python SDK generator:
31+
Add the Python SDK generator:
3232

33-
```bash
34-
fern add fern-python-sdk --group sdk
35-
```
33+
```bash
34+
fern add fern-python-sdk --group sdk
35+
```
3636

37-
This command adds the following to `generators.yml`:
37+
This command adds the following to `generators.yml`:
3838

39-
```yaml
40-
sdk:
41-
generators:
42-
- name: fernapi/fern-python-sdk
43-
version: <Markdown src="/snippets/version-number.mdx"/>
44-
output:
45-
location: local-file-system
46-
path: ../sdks/python
47-
```
39+
```yaml
40+
sdk:
41+
generators:
42+
- name: fernapi/fern-python-sdk
43+
version: <Markdown src="/snippets/version-number.mdx"/>
44+
output:
45+
location: local-file-system
46+
path: ../sdks/python
47+
```
4848
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4949
5050
```bash

‎fern/products/sdks/overview/typescript/quickstart.mdx‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,35 +15,35 @@ Generate a TypeScript SDK by following the instructions on this page.
1515
You can use either the OpenAPI definition, AsyncAPI definition, or Fern Definition to generate your SDK.
1616

1717
<AccordionGroup>
18-
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>
18+
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>
1919

20-
<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>
21-
22-
<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>
20+
<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>
21+
22+
<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>
2323

2424
</AccordionGroup>
2525

2626
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
2727

28-
### Add the SDK generator
28+
### Add the SDK generator
2929

30-
Add the TypeScript SDK generator:
30+
Add the TypeScript SDK generator:
3131

32-
```bash
33-
fern add fern-typescript-node-sdk --group sdk
34-
```
32+
```bash
33+
fern add fern-typescript-node-sdk --group sdk
34+
```
35+
36+
This command adds the following to `generators.yml`:
3537

36-
This command adds the following to `generators.yml`:
37-
38-
```yaml
39-
sdk:
40-
generators:
41-
- name: fernapi/fern-typescript-node-sdk
42-
version: <Markdown src="/snippets/version-number.mdx"/>
43-
output:
44-
location: local-file-system
45-
path: ../sdks/typescript
46-
```
38+
```yaml
39+
sdk:
40+
generators:
41+
- name: fernapi/fern-typescript-node-sdk
42+
version: <Markdown src="/snippets/version-number.mdx"/>
43+
output:
44+
location: local-file-system
45+
path: ../sdks/typescript
46+
```
4747
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4848
4949
```bash

‎fern/products/sdks/snippets/option-3-fern-def.mdx‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<Accordion title="Option 3: Fern Definition">
2-
1. Initialize the Fern folder using the Fern Definition by running the following command:
2+
1. Initialize the Fern folder using the Fern Definition by running the following command:
33

44
```bash
55
fern init --organization <YourOrganization>
@@ -26,31 +26,31 @@
2626
replace `imdb.yml` with your own endpoints, types, and errors before
2727
proceeding with the rest of this page. </Note>
2828

29-
{/* TODO: show what generators.yml looks like, link out to configuration.md */}
30-
31-
1. Add the config option `outputSourceFiles: true` to
32-
`generators.yml`. This ensures your SDK contains source files in
33-
your preferred SDK language instead of compiled output.
34-
35-
```yaml {11-12}
36-
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
37-
default-group: local
38-
groups:
39-
local:
40-
generators:
41-
- name: fernapi/fern-typescript-node-sdk
42-
output:
43-
location: local-file-system
44-
path: ../sdks/typescript
45-
version: <Markdown src="/snippets/version-number.mdx"/>
46-
config:
47-
outputSourceFiles: true
48-
```
49-
50-
<Note>`fern init` creates a default configuration that includes the
51-
TypeScript Node SDK generator. The `local` group containing this
52-
generator only generates if you run fern generate without specifying a
53-
group, or if you explicitly target it with `fern generate --group
54-
local`. In subsequent steps, you'll add an additional generator for your
55-
preferred SDK language.</Note>
56-
</Accordion>
29+
{/* TODO: show what generators.yml looks like, link out to configuration.md */}
30+
31+
2. Add the config option `outputSourceFiles: true` to
32+
`generators.yml`. This ensures your SDK contains source files in
33+
your preferred SDK language instead of compiled output.
34+
35+
```yaml {11-12}
36+
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
37+
default-group: local
38+
groups:
39+
local:
40+
generators:
41+
- name: fernapi/fern-typescript-node-sdk
42+
output:
43+
location: local-file-system
44+
path: ../sdks/typescript
45+
version: <Markdown src="/snippets/version-number.mdx"/>
46+
config:
47+
outputSourceFiles: true
48+
```
49+
50+
<Note>`fern init` creates a default configuration that includes the
51+
TypeScript Node SDK generator. The `local` group containing this
52+
generator only generates if you run fern generate without specifying a
53+
group, or if you explicitly target it with `fern generate --group
54+
local`. In subsequent steps, you'll add an additional generator for your
55+
preferred SDK language.</Note>
56+
</Accordion>

0 commit comments

Comments
 (0)