diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx
index 442f8d74d..1a2e94f57 100644
--- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx
+++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx
@@ -1,7 +1,7 @@
---
-title: "Docs.yml"
-subtitle: "Customize your documentation using the docs.yml file"
-description: "Learn how to configure your Fern documentation site with the docs.yml file. Customize colors, typography, layout, analytics and more."
+title: Docs.yml
+subtitle: Customize your documentation using the docs.yml file
+description: Learn how to configure your Fern documentation site with the docs.yml file. Customize colors, typography, layout, analytics and more.
---
The `docs.yml` file is your primary tool for customizing your documentation site, including colors, typography, layout, analytics, and more. Start here for most customization needs before considering [custom CSS and JavaScript](/docs/customization/custom-css-js) for advanced use cases.
@@ -276,7 +276,6 @@ background-image:
Relative filepath to the dark-mode background image.
-
## Typography configuration
```yaml docs.yml
@@ -319,47 +318,50 @@ typography:
### Font configuration
-
-```yaml
-typography:
- bodyFont:
- name: Inter-Regular
- path: fonts/Inter-Regular.woff2
- style: normal
-```
-
-
-
-```yaml
-typography:
- headingsFont:
- name: Inter-Variable
- paths:
- - path: ./fonts/Inter-Variable.woff2
- weight: 400 700 # Supports range of weights
- style: normal
-```
-
+
+ ```yaml
+ typography:
+ bodyFont:
+ name: Inter-Regular
+ path: fonts/Inter-Regular.woff2
+ style: normal
+ ```
+
+
+
+ ```yaml
+ typography:
+ headingsFont:
+ name: Inter-Variable
+ paths:
+ - path: ./fonts/Inter-Variable.woff2
+ weight: 400 700 # Supports range of weights
+ style: normal
+ ```
+
+
+
+
+ ```yaml
+ typography:
+ headingsFont:
+ name: Inter
+ paths:
+ - path: ./fonts/Inter-Regular.woff2
+ weight: 400
+ style: normal
+ - path: ./fonts/Inter-Bold.woff2
+ weight: 700
+ style: normal
+ - path: ./fonts/Inter-Italic.woff2
+ weight: 400
+ style: italic
+ ```
-
-```yaml
-typography:
- headingsFont:
- name: Inter
- paths:
- - path: ./fonts/Inter-Regular.woff2
- weight: 400
- style: normal
- - path: ./fonts/Inter-Bold.woff2
- weight: 700
- style: normal
- - path: ./fonts/Inter-Italic.woff2
- weight: 400
- style: italic
-```
-
+
+
The name of the font. Defaults to a generated name that will be used to reference your custom font in the eventually injected CSS.
@@ -415,19 +417,19 @@ layout:
- Sets the placement of the searchbar. Can be one of `header`, `sidebar` or `header-tabs` (places the searchbar in the header but on the tabs row).
- Defaults to `sidebar`.
+ Sets the placement of the searchbar. Can be one of `header`, `sidebar` or `header-tabs` (places the searchbar in the header but on the tabs row). Defaults to `sidebar`.
This setting is ignored when `disable-header` is set to true.
+
- Set the placement of the tabs. Can be one of `header` or `sidebar`.
- Defaults to `sidebar`.
+ Set the placement of the tabs. Can be one of `header` or `sidebar`. Defaults to `sidebar`.
This setting is ignored when `disable-header` is set to true.
+
Set the alignment of the Markdown content. Can be one of `center` or `left`.
Defaults to `center`.
@@ -449,39 +451,41 @@ layout:
## GitHub configuration
-
-```yaml
-instances:
- - url: plantstore.docs.buildwithfern.com
- edit-this-page:
- github:
- owner: fern
- repo: plant-store-docs
- branch: main
-```
-
-
-
-```yaml
-# Configure edit-this-page per instance
-instances:
- - url: plantstore.docs.buildwithfern.com
- custom-domain: docs.plantstore.com
- edit-this-page:
- github:
- owner: fern
- repo: plant-store-docs
- branch: production
- - url: plantstore-staging.docs.buildwithfern.com
- edit-this-page:
- github:
- owner: fern
- repo: plant-store-docs
- branch: staging
-```
-
+
+ ```yaml
+ instances:
+ - url: plantstore.docs.buildwithfern.com
+ edit-this-page:
+ github:
+ owner: fern
+ repo: plant-store-docs
+ branch: main
+ ```
+
+
+
+ ```yaml
+ # Configure edit-this-page per instance
+ instances:
+ - url: plantstore.docs.buildwithfern.com
+ custom-domain: docs.plantstore.com
+ edit-this-page:
+ github:
+ owner: fern
+ repo: plant-store-docs
+ branch: production
+ - url: plantstore-staging.docs.buildwithfern.com
+ edit-this-page:
+ github:
+ owner: fern
+ repo: plant-store-docs
+ branch: staging
+ ```
+
+
+
The GitHub repository must be **public** for the "Edit this page" feature to work correctly.
@@ -557,7 +561,7 @@ analytics:
Your PostHog project API key. Defaults to the api-host of "https://us.i.posthog.com".
-
+
## Dynamic snippets configuration
@@ -569,5 +573,3 @@ Enable dynamic snippets in `docs.yml`, then configure them by [following the SDK
experimental:
dynamic-snippets: true
```
-
-