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
Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
52
+
</CodeBlock>
53
+
</CodeBlocks>
54
+
</Warning>
55
+
56
+
Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
57
+
58
+
```bash
59
+
fern generate --docs
60
+
```
55
61
56
-
```bash
57
-
fern generate --docs
58
-
```
59
62
</Accordion>
60
-
<Accordion title='Use the Fern CLI'>
61
-
If you prefer, you can use our CLI to create a new project. Install the CLI
62
-
by running
63
63
64
-
```bash
65
-
npm install -g fern-api
66
-
```
64
+
<Accordion title="Use the Fern CLI">
65
+
If you prefer, you can use our CLI to create a new project. Install the CLI by running
67
66
68
-
Then run
67
+
```bash
68
+
npm install -g fern-api
69
+
```
69
70
70
-
```bash
71
-
fern init --docs
72
-
```
71
+
Then run
73
72
74
-
You will see a new `fern` folder in your project with the following structure:
73
+
```bash
74
+
fern init --docs
75
+
```
75
76
76
-
```bash
77
-
fern
78
-
├─ docs.yml
79
-
└─ fern.config.json
80
-
```
81
-
Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
77
+
You will see a new `fern` folder in your project with the following structure:
78
+
79
+
```bash
80
+
fern
81
+
├─ docs.yml
82
+
└─ fern.config.json
83
+
```
84
+
85
+
Finally, navigate to the docs directory (where the `fern` folder is located) and execute the following command to generate your documentation:
86
+
87
+
```bash
88
+
fern generate --docs
89
+
```
82
90
83
-
```bash
84
-
fern generate --docs
85
-
```
86
91
</Accordion>
87
92
93
+
<Accordion title="My next page">
94
+
Here's my content.
95
+
96
+
<Callout intent="note">
97
+
Warning you should save before closing
98
+
99
+
</Callout>
100
+
</Accordion>
88
101
</AccordionGroup>
89
102
90
103
### Update your docs
91
104
92
105
<Note>
93
106
We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it
94
-
[here](https://buildwithfern.com/contact).
107
+
[here](https://buildwithfern.com/contact).
108
+
95
109
</Note>
96
110
97
111
<AccordionGroup toc={true}>
98
-
<Accordion title='Add content' >
99
-
Add content with MDX files.
100
-
101
-
```markdown
102
-
---
103
-
title: "Page Title"
104
-
description: "Subtitle (optional)"
105
-
---
106
-
107
-
Hello world!
108
-
```
112
+
<Accordion title="Add content">
113
+
Add content with MDX files.
114
+
115
+
```markdown
116
+
---
117
+
title: "Page Title"
118
+
description: "Subtitle (optional)"
119
+
---
120
+
121
+
Hello world!
122
+
```
109
123
110
-
<Note title="Supported Syntax">
124
+
<Note title="Supported Syntax">
111
125
Fern supports [GitHub flavored Markdown (GFM)](https://github.github.com/gfm/) within MDX files, no plugin required.
112
-
</Note>
126
+
</Note>
113
127
114
-
In order for the Markdown page to show up, you'll need to reference them from your `docs.yml` file. You
115
-
can reference the Markdown page within a section or as a standalone page.
128
+
In order for the Markdown page to show up, you'll need to reference them from your `docs.yml` file. You can reference the Markdown page within a section or as a standalone page.
116
129
117
-
```yml
118
-
navigation:
119
-
- page: Hello World
120
-
path: docs/pages/hello-world.mdx
121
-
- section: Overview
122
-
contents:
123
-
- page: QuickStart
124
-
path: docs/pages/hello-world.mdx
125
-
```
126
-
</Accordion>
127
-
<Accordion title='Add an API Reference' >
128
-
Add an API Reference by adding an OpenAPI Specification to your project.
130
+
```
131
+
navigation:
132
+
- page: Hello World
133
+
path: docs/pages/hello-world.mdx
134
+
- section: Overview
135
+
contents:
136
+
- page: QuickStart
137
+
path: docs/pages/hello-world.mdx
138
+
```
139
+
</Accordion>
129
140
130
-
```bash
131
-
fern init --openapi /path/to/openapi.yml
132
-
```
141
+
<Accordiontitle="Add an API Reference">
142
+
Add an API Reference by adding an OpenAPI Specification to your project.
133
143
134
-
This will create an `openapi.yml` file in your project. You can reference this file in your
135
-
`docs.yml`file by adding an api block.
144
+
```bash
145
+
fern init --openapi /path/to/openapi.yml
146
+
```
136
147
137
-
```yml
138
-
navigation:
139
-
- api: "API Reference"
140
-
```
141
-
</Accordion>
142
-
<Accordion title='Brand your docs'>
143
-
All of the branding for your docs can be configured in the `docs.yml` file.
148
+
This will create an `openapi.yml` file in your project. You can reference this file in your `docs.yml` file by adding an api block.
144
149
145
-
For example, to set the logos, colors, and fonts for your docs, you can
146
-
add the following to your `docs.yml` file:
150
+
```
151
+
navigation:
152
+
- api: "API Reference"
153
+
```
154
+
</Accordion>
147
155
148
-
<CodeBlock title="docs.yml">
156
+
<Accordiontitle="Brand your docs">
157
+
All of the branding for your docs can be configured in the `docs.yml` file.
158
+
159
+
For example, to set the logos, colors, and fonts for your docs, you can add the following to your `docs.yml` file:
160
+
161
+
<CodeBlocktitle="docs.yml">
149
162
```yml
150
163
colors:
151
164
accent-primary:
@@ -160,44 +173,48 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
160
173
161
174
favicon: docs/assets/favicon.svg
162
175
```
163
-
</CodeBlock>
164
-
165
-
</Accordion>
176
+
</CodeBlock>
177
+
</Accordion>
166
178
167
179
</AccordionGroup>
168
-
180
+
169
181
### Preview your docs
182
+
170
183
<AccordionGroup toc={true}>
171
-
<Accordion title='Preview your docs locally'>
172
-
You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally).
173
-
</Accordion>
174
-
<Accordion title='Preview your docs in a PR'>
175
-
`PR previews`offer a way to preview changes from pull requests (PRs) before merging code to a production branch. Learn more [here](/docs/preview-publish/previewing-changes-in-a-pr).
176
-
</Accordion>
184
+
<Accordion title="Preview your docs locally">
185
+
You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally).
186
+
</Accordion>
187
+
188
+
<Accordion title="Preview your docs in a PR">
189
+
`PR previews` offer a way to preview changes from pull requests (PRs) before merging code to a production branch. Learn more [here](/docs/preview-publish/previewing-changes-in-a-pr).
190
+
</Accordion>
191
+
177
192
</AccordionGroup>
178
-
193
+
179
194
### Publish to production
180
195
181
196
<AccordionGroup toc={true}>
182
-
<Accordion title='Publishing your docs'>
183
-
When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI.
197
+
<Accordion title="Publishing your docs">
198
+
When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI.
![fern-api[bot]](https://avatars.githubusercontent.com/in/244756?v=4&size=40){kind=avatar}
0 commit comments