Skip to content

Commit 116ccb2

Browse files
committed
document github link option
1 parent a4b59a7 commit 116ccb2

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,14 +242,20 @@ navbar-links:
242242
text: Login
243243
href: https://example.com/login
244244
rounded: false
245+
- type: github
246+
value: https://github.com/example-company/fern
245247
```
246248

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

251253
<ParamField path="href" type="string" required={false}>
252-
The url once you click on the button. Example: https://buildwithfern.com/contact
254+
The URL once you click on the button. Example: https://buildwithfern.com/contact
255+
</ParamField>
256+
257+
<ParamField path="value" type="string" required={false}>
258+
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
253259
</ParamField>
254260

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

0 commit comments

Comments
 (0)