Skip to content

Commit

Permalink
fix: style property name instead of styling (#271)
Browse files Browse the repository at this point in the history
  • Loading branch information
mayankshouche authored Sep 19, 2024
1 parent 0a3dc01 commit 1682f86
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions settings/global.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,25 @@ settings. Learn more about the [properties](#properties) or from an
</ResponseField>

<ResponseField name="theme" type={'"venus" | "quill" | "prism"'}>
A preset theme configuration that changes the look and feel of the project. A theme is a set of default styling configurations.

Examples:
A preset theme configuration that changes the look and feel of the project. A
theme is a set of default styling configurations. Examples:
[Venus](https://starter-venus.mintlify.app),
[Quill](https://starter-quill.mintlify.app),
[Prism](https://starter-prism.mintlify.app)
</ResponseField>

<ResponseField name="layout" type={'"topnav" | "sidenav" | "solidSidenav"'} default="topnav">
<ResponseField
name="layout"
type={'"topnav" | "sidenav" | "solidSidenav"'}
default="topnav"
>
The global layout style of the documentation.
</ResponseField>

<ResponseField name="background" type="Background">
Set a decorative background.
<Expandable title="Background">
<ResponseField name="styling" type={'"gradient" | "grid" | "windows"'}>
<ResponseField name="style" type={'"gradient" | "grid" | "windows"'}>
The style of the decorative background.
</ResponseField>
</Expandable>
Expand Down Expand Up @@ -147,13 +150,18 @@ settings. Learn more about the [properties](#properties) or from an

</CodeGroup>
</ResponseField>

</Expandable>
</ResponseField>

<ResponseField name="sidebar" type="Sidebar">
Customize the styling of components within the sidebar.
<Expandable title="Sidebar">
<ResponseField name="items" type={'"container" | "card" | "border" | "undecorated"'} default="container">
<ResponseField
name="items"
type={'"container" | "card" | "border" | "undecorated"'}
default="container"
>
The styling of the navigation item.
</ResponseField>
</Expandable>
Expand All @@ -162,7 +170,11 @@ settings. Learn more about the [properties](#properties) or from an
<ResponseField name="topbar" type="Topbar">
Styling configurations for the topbar.
<Expandable title="Topbar">
<ResponseField name="styling" type={'"default" | "gradient"'} default="default">
<ResponseField
name="style"
type={'"default" | "gradient"'}
default="default"
>
The styling of the navigation item.
</ResponseField>
</Expandable>
Expand Down Expand Up @@ -216,13 +228,13 @@ settings. Learn more about the [properties](#properties) or from an

<ResponseField name="topbarCtaButton" type="Call to Action">
<Expandable title="Topbar Call to Action">
<ResponseField name="type" type={'link or github'} default="link">
Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
<ResponseField name="type" type={"link or github"} default="link">
Link shows a button. GitHub shows the repo information at the url provided
including the number of GitHub stars.
</ResponseField>
<ResponseField name="url" type="string">
If type is a link: What the button links to.

If type is a github: Link to the repository to load GitHub information from.
If type is a link: What the button links to. If type is a github: Link to
the repository to load GitHub information from.
</ResponseField>
<ResponseField name="name" type="string">
Text inside the button. Only required if type is a link.
Expand Down

0 comments on commit 1682f86

Please sign in to comment.