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
Copy file name to clipboardExpand all lines: README.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
# Docs Starter
10
10
11
-
Create beautiful documentation in under 5 minutes using an OpenAPI specification.
11
+
Create beautiful documentation in under 5 minutes using your OpenAPI specification.
12
12
13
13
</div>
14
14
@@ -22,12 +22,17 @@ Get inspired by API documentation built with Fern: [Webflow](https://developers.
22
22
23
23
- Node 18 or higher
24
24
- A [GitHub](https://github.com) account
25
+
- Knowledge of the command line
25
26
26
27
### Step 1: Use this template
27
28
28
29
1. Click on the **Use this template** button (found at the top right of this page). You must be logged into GitHub.
29
30
2. Choose the option to **create a new repository**. Name it `fern-docs`.
30
-
3. Install the Fern CLI by running:
31
+
3. Install the Fern Command Line Interface (CLI) by running:
32
+
33
+
```bash
34
+
npm install -g fern-api
35
+
```
31
36
32
37
### Step 2: Clone and open the repo in your preferred code editor
33
38
@@ -44,7 +49,7 @@ Open the `fern.config.json` file and change the organization name:
44
49
45
50
```json
46
51
{
47
-
"organization": "your-organization-name",
52
+
"organization": "your-company-name",
48
53
"version": "0.77.4"
49
54
}
50
55
```
@@ -55,12 +60,13 @@ Run the following command to ensure you are using the latest version of Fern:
55
60
fern upgrade
56
61
```
57
62
58
-
**2. Update `docs.yml`:**
59
-
Open the `docs.yml` file and update the URL:
63
+
Replace `plantstore` with your own organization's name. Use only alphanumeric characters, hyphens, and underscores. Do not use spaces and leave the rest of the URL (`docs.buildwithfern.com`) unchanged.
0 commit comments