Skip to content

Use ScrollWalkthrough on the npm publishing page #6604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fern-api wants to merge 3 commits into
base: main
Choose a base branch
from
+26 −54
Open

Use ScrollWalkthrough on the npm publishing page #6604

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b6f1609
Use ScrollWalkthrough for npm publishing config steps
fern-api[bot] Aug 12, 2026
7dcb6ad
Widen scroll walkthrough panel on npm publishing page
fern-api[bot] Aug 12, 2026
2ec8983
Use highlight instead of focus in npm publishing walkthrough
fern-api[bot] Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 26 additions & 54 deletions fern/products/sdks/generators/typescript/publishing-to-npm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,60 +38,32 @@ Default to OIDC authentication unless the user has a specific reason to use toke

Update your `generators.yml` file to configure the package name, output location, and client naming for npm publishing. Your `generators.yml` [should live in your source repository](/learn/sdks/overview/project-structure) (or on your local machine), not the repository that contains your TypeScript SDK code.

<Steps>
<Step title="Configure `output` location">

In the `group` for your TypeScript SDK, change the output location from `local-file-system` (the default) to `npm` to indicate that Fern should publish your package directly to the npmjs registry:

```yaml {6-7} title="generators.yml"
groups:
ts-sdk: # Group name for your TypeScript SDK
generators:
- name: fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/>
output:
location: npm
```

</Step>

<Step title="Add a unique package name">

Your package name must be unique in the npmjs registry, otherwise publishing your SDK will fail.

```yaml {8} title="generators.yml"
groups:
ts-sdk:
generators:
- name: fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/>
output:
location: npm
package-name: your-package-name
```

</Step>

<Step title="Configure `namespaceExport`">

The `namespaceExport` option controls the name of the generated client. This is the name customers use to import your SDK (`import { your-client-name } from 'your-package-name';`).

```yaml {9-10} title="generators.yml"
groups:
ts-sdk:
generators:
- name: fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/>
output:
location: npm
package-name: your-package-name
config:
namespaceExport: YourClientName # must be PascalCase
```

</Step>

</Steps>
<ScrollWalkthrough layout="wide" panelHeight="18rem">
<Step title="Configure `output` location" file="generators.yml" highlight="6-7">
In the `group` for your TypeScript SDK, change the output location from `local-file-system` (the default) to `npm` to indicate that Fern should publish your package directly to the npmjs registry.
</Step>

<Step title="Add a unique package name" file="generators.yml" highlight="8">
Your package name must be unique in the npmjs registry, otherwise publishing your SDK will fail.
</Step>

<Step title="Configure `namespaceExport`" file="generators.yml" highlight="9-10">
The `namespaceExport` option controls the name of the generated client. This is the name customers use to import your SDK (`import { your-client-name } from 'your-package-name';`).
</Step>

```yaml generators.yml
groups:
ts-sdk: # Group name for your TypeScript SDK
generators:
- name: fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/>
output:
location: npm
package-name: your-package-name
config:
namespaceExport: YourClientName # must be PascalCase
```
</ScrollWalkthrough>

## Configure GitHub publishing

Expand Down
Loading