You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Demo] A Fern configuration that generates Docs & SDKs for Stripe's API.
1
+
# Stripe Demo Fern Configuration
2
+
3
+
This repository contains the Stripe Demo Fern configuration:
4
+
-[OpenAPI](./openapi.yaml)
5
+
-[Generators configuration](./generators.yml)
6
+
7
+
## Validating your API Definition
8
+
9
+
To validate the API, run:
10
+
```bash
11
+
npm install -g fern-api # only required once
12
+
fern check
13
+
```
14
+
15
+
## Updating your Docs
16
+
17
+
View your generated documentation website at [stripe.docs.buildwithfern.com](https://stripe.docs.buildwithfern.com).
18
+
19
+
### Local Development server
20
+
21
+
To run a local development server with hot-reloading you can run the following command
22
+
23
+
```bash
24
+
fern docs dev
25
+
```
26
+
27
+
### Hosted URL
28
+
29
+
Documentation is automatically updated when you push to main via the `fern generate` command
30
+
31
+
```bash
32
+
npm install -g fern-api # only required once
33
+
fern generate --docs
34
+
```
35
+
36
+
## Generate the TypeScript SDK
37
+
38
+
To update the TypeScript SDK, simply run the `Release Node.js SDK` GitHub Action with the desired version for the release. Under the hood, this leverages the Fern CLI:
0 commit comments