Skip to content
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.

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

fix: topbarcta -> topbarctabutton #352

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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: 15 additions & 18 deletions settings/navigation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Navigation"
description:
"Organize your docs directory to guide your users to the information they need "
description: "Organize your docs directory to guide your users to the information they need "
icon: "map"
---

Expand All @@ -12,6 +11,7 @@ documentation. They show up above the main sidebar.

<Frame>
<img className="block dark:hidden rounded-md" src="/images/tabs-light.png" />

<img className="hidden dark:block rounded-md" src="/images/tabs-dark.png" />
</Frame>

Expand Down Expand Up @@ -52,10 +52,8 @@ Anchors provide another way to direct users to sections of your documentation,
or link out to external URLs.

<Frame>
<img
className="block dark:hidden rounded-md"
src="/images/anchor-light.png"
/>
<img className="block dark:hidden rounded-md" src="/images/anchor-light.png" />

<img className="hidden dark:block rounded-md" src="/images/anchor-dark.png" />
</Frame>

Expand Down Expand Up @@ -148,15 +146,14 @@ would make a folder called `your-folder` containing an MDX file called
</Warning>

<CodeGroup>

```json Navigation With Folder
"navigation": [
{
"group": "Group Name",
"pages": ["your-folder/your-page"]
}
]
```
```json Navigation With Folder
"navigation": [
{
"group": "Group Name",
"pages": ["your-folder/your-page"]
}
]
```

```json Nested Navigation
"navigation": [
Expand Down Expand Up @@ -208,17 +205,17 @@ The `topbarLinks` field supports the following fields: `name`, `url`.

### CTA Button

Customize the call-to-action (CTA) button in the topbar using the `topbarCTA`
Customize the call-to-action (CTA) button in the topbar using the `topbarCtaButton`
field.

<Frame>
<img className="block rounded-md" src="/images/topbar-cta-get-started.png" />
</Frame>

The `topbarCTA` field supports the following fields: `name`, `url`, and `type`.
The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. For more information on the options for these fields, see the [mint.json schema](/settings/global#structure).

```json
"topbarCTA": {
"topbarCtaButton": {
"name": "Get Started",
"url": "https://mintlify.com/get-started"
}
Expand Down