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
@@ -61,6 +61,10 @@ The `assets` folder contains any images or videos used in your documentation. Yo
61
61
62
62
The `docs.yml` file is the heart of your Fern documentation site. This configuration file controls your documentation's navigation structure, visual design, site functionality, and hosting settings. Only files referenced in your `docs.yml` navigation (or discovered via a [`folder` configuration](/learn/docs/configuration/navigation#auto-populate-from-folder)) are included in builds — any unreferenced files are ignored.
63
63
64
+
<Note>
65
+
Fern treats `.yml` and `.yaml` extensions identically. This applies to all YAML files in a Fern project, including `docs.yml`, `generators.yml`, and API specification files.
66
+
</Note>
67
+
64
68
For complete configuration options, see the [`docs.yml` reference](/docs/configuration/site-level-settings).
65
69
66
70
<CodeBlocktitle="Example fern/docs.yml">
@@ -132,7 +136,7 @@ To generate [API Reference](/docs/api-references/generate-api-ref) documentation
132
136
```yaml title="generators.yml"
133
137
api:
134
138
specs:
135
-
- openapi: openapi.yaml
139
+
- openapi: openapi.yml
136
140
```
137
141
138
142
You can optionally [add an overlays file](/learn/api-definitions/openapi/overlays) for additional customizations. To see this in practice, check out [Fluidstack's Fern configuration](https://github.com/fluidstackio/fern-config/tree/main/fern/openapi).
@@ -144,7 +148,7 @@ To generate [API Reference](/docs/api-references/generate-api-ref) documentation
144
148
```yaml title="generators.yml"
145
149
api:
146
150
specs:
147
-
- openapi: openapi.yaml
151
+
- openapi: openapi.yml
148
152
- asyncapi: asyncapi.yaml
149
153
```
150
154
@@ -162,7 +166,7 @@ To generate [API Reference](/docs/api-references/generate-api-ref) documentation
@@ -182,7 +182,7 @@ This guide covers the CLI path. A browser-based guided setup also exists at http
182
182
</Accordion>
183
183
<Accordion title='Add an API Reference' >
184
184
185
-
If you cloned the starter template, you already have an `openapi.yaml` file with sample API definitions. If you started from scratch, add your OpenAPI spec:
185
+
If you cloned the starter template, you already have an `openapi.yml` file with sample API definitions (both `.yml` and `.yaml` work interchangeably). If you started from scratch, add your OpenAPI spec:
0 commit comments