Skip to content

Document github link option (Docs) #795

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
Sep 15, 2025
Merged

Document github link option (Docs) #795

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
10 changes: 8 additions & 2 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 @@ -242,14 +242,20 @@ navbar-links:
text: Login
href: https://example.com/login
rounded: false
- type: github
value: https://github.com/example-company/fern
```

<ParamField path="type" type="enum" required={false}>
One of `outlined`, `minimal`, or `filled`. This value controls the styling of the button.
One of `outlined`, `minimal`, `filled`, or `github`. This value controls the styling of the button.
</ParamField>

<ParamField path="href" type="string" required={false}>
The url once you click on the button. Example: https://buildwithfern.com/contact
The URL once you click on the button. Example: https://buildwithfern.com/contact
</ParamField>

<ParamField path="value" type="string" required={false}>
The URL to a GitHub repository. Similar to `href`, but specifically for GitHub repository links. This field is used when `type` is set to `github`. Example: https://github.com/example-company/fern
</ParamField>

<ParamField path="text" type="string" required={false}>
Expand Down