Skip to content

feat: custom fonts #255

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 6 commits into from
Sep 18, 2024
Merged

feat: custom fonts #255

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d89a0e6
Update global.mdx
rickyzhangca Aug 21, 2024
5cc45b1
Update global.mdx
rickyzhangca Sep 4, 2024
1a882bc
Update global.mdx
rickyzhangca Sep 5, 2024
45d77d7
Update global.mdx
rickyzhangca Sep 10, 2024
0f4da50
add details
hahnbeelee Sep 18, 2024
3ee8e4f
remove space
hahnbeelee Sep 18, 2024
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
33 changes: 31 additions & 2 deletions settings/global.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,35 @@ settings. Learn more about the [properties](#properties) or from an
[Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
</ResponseField>

<ResponseField
name="font"
type={
"FontDetailsType | { headings?: FontDetailsType, body?: FontDetailsType }"
}
>
Custom fonts. Apply globally or set different fonts for headings and the body
text.
<Expandable title="FontDetailsType">
<ResponseField name="family" type="string" required>
The font family name. Custom fonts and all [Google
Fonts](https://fonts.google.com/) are supported. e.g. "Open Sans",
"Playfair Display"
</ResponseField>
<ResponseField name="weight" type="number">
The font weight. Precise values such as `560` are also supported for
variable fonts. Check under the Styles section for your Google Font for
the available weights.
</ResponseField>
<ResponseField name="url" type="string">
The URL to the font file. Can be used to specify a font that is not from
Google Fonts.
</ResponseField>
<ResponseField name="format" type="'woff' | 'woff2">
The font format. Required if using a custom font source (`url`).
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="modeToggle" type="ModeToggle">
Customize the dark mode toggle.
<Expandable title="ModeToggle">
Expand All @@ -86,7 +115,6 @@ settings. Learn more about the [properties](#properties) or from an
</ResponseField>
<ResponseField name="isHidden" type="boolean" default={false}>
Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:

<CodeGroup>
```json Only Dark Mode
"modeToggle": {
Expand Down Expand Up @@ -542,4 +570,5 @@ Click on the following dropdown to view a sample configuration file

## More Customization

Learn more about how to further customize your docs with custom CSS and JS in [Custom Scripts](https://mintlify.com/docs/integrations/custom/).
Learn more about how to further customize your docs with custom CSS and JS in
[Custom Scripts](https://mintlify.com/docs/integrations/custom/).