Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 31 additions & 40 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
Original file line number Diff line number Diff line change
@@ -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. Hey this is deep! '
description: Learn how to configure your Fern documentation site with the docs.yml file. Customize colors, typography, layout, analytics and more.
---

### YAML Schema Validation
Expand Down Expand Up @@ -129,7 +129,7 @@ instances:
If specified, adds an "Edit this page" link to the bottom of each page that links to the given public GitHub repository. Learn more about the [`edit-this-page` configuration](#github-configuration).
</ParamField>

## Colors configuration
## Colors configuration

```yaml docs.yml
colors:
Expand Down Expand Up @@ -286,8 +286,7 @@ background-image:
Relative filepath to the dark-mode background image.
</ParamField>


## Typography configuration
## Typography configuration

```yaml docs.yml
typography:
Expand Down Expand Up @@ -329,43 +328,35 @@ typography:
### Font configuration

<Tabs>
<Tab title="Single Weight">
```yaml
typography:
bodyFont:
name: Inter-Regular
path: fonts/Inter-Regular.woff2
style: normal
```
</Tab>

<Tab title="Variable Font">
<Tab title="Single Instance">
```yaml
typography:
headingsFont:
name: Inter-Variable
paths:
- path: ./fonts/Inter-Variable.woff2
weight: 400 700 # Supports range of weights
style: normal
instances:
- url: plantstore.docs.buildwithfern.com
edit-this-page:
github:
owner: fern
repo: plant-store-docs
branch: main
```
</Tab>

<Tab title="Multiple Files">
<Tab title="Multiple Instances">
```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
# 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
```
</Tab>
</Tabs>
Expand All @@ -391,7 +382,7 @@ typography:
A list of font files for particular weights. Each element in the list includes a `path`, `weight`, and `style` property.
</ParamField>

## Layout configuration
## Layout configuration

```yaml docs.yml
layout:
Expand Down Expand Up @@ -557,4 +548,4 @@ analytics:

<ParamField path="analytics.posthog.api-key" type="string" required={false}>
Your PostHog project API key. Defaults to the api-host of "https://us.i.posthog.com".
</ParamField>
</ParamField>
2 changes: 1 addition & 1 deletion fern/products/docs/pages/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,4 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
</div>
</a>
</CardGroup>
</div>
</div>
3 changes: 1 addition & 2 deletions fern/products/home/pages/welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ hide-toc: true
layout: custom
---


import { FernFooter } from "../../../components/FernFooter";

<div className="lp-page-container">
Expand Down Expand Up @@ -377,4 +376,4 @@ import { FernFooter } from "../../../components/FernFooter";
</div>

</div>
</div>
</div>