Skip to content

chore: landing page slug configuration options #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2025
Merged

chore: landing page slug configuration options #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,7 @@ The GitHub repository must be **public** for the "Edit this page" feature to wor
landing-page:
page: Page Title
path: path/to/landing-page.mdx
slug: /welcome
```

<ParamField path="page" type="string" required={true}>
Expand All @@ -514,6 +515,12 @@ landing-page:
Relative filepath to the desired landing page Markdown file.
</ParamField>

<ParamField path="slug" type="string" required={false}>
The slug of the landing page. Defaults to the page name.

The slug can also be overridden in the frontmatter of the landing page Markdown file.
</ParamField>

See [Vapi's landing page live](https://docs.vapi.ai/) and the associated [Markdown file](https://github.com/VapiAI/docs/blob/main/fern/quickstart/introduction.mdx?plain=1).

## Metadata configuration
Expand Down
10 changes: 10 additions & 0 deletions fern/products/docs/pages/seo/configuring-slugs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ navigation:

In the example above, the **Welcome** page would be hosted at `plantstore.docs.buildwithfern.com/guides/get-started/welcome`.

#### Modify a landing page's slug
To modify the slug used for a tab, you can set the `slug` within the `landing-page` object.

```yaml title="docs.yml" {4}
landing-page:
page: Page Title
path: path/to/landing-page.mdx
slug: /welcome
```

#### Override a page's slug
You can set the exact slug of a page within its frontmatter. [You can read more about the frontmatter configuration here](/learn/docs/content/frontmatter#slug).

Expand Down