Skip to content

Commit

Permalink
Documentation edits made through Mintlify web editor
Browse files Browse the repository at this point in the history
  • Loading branch information
mayankshouche committed Nov 14, 2024
1 parent abe76ea commit 2e3857e
Showing 1 changed file with 31 additions and 34 deletions.
65 changes: 31 additions & 34 deletions settings/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,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 +53,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 @@ -136,7 +135,7 @@ Create groups by recursively nesting a group within a group.

Simply put your MDX files in folders and update the paths in `mint.json`.

For example, to have a page at `https://yoursite.com/your-folder/your-page` you
For example, to have a page at [`https://yoursite.com/your-folder/your-page`](https://yoursite.com/your-folder/your-page) you
would make a folder called `your-folder` containing an MDX file called
`your-page.mdx`.

Expand All @@ -148,31 +147,29 @@ 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 Nested Navigation
"navigation": [
{
"group": "Getting Started",
"pages": [
"quickstart",
{
"group": "Nested Reference Pages",
"pages": ["nested-reference-page"]
}
]
}
]
```

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

```json Nested Navigation
"navigation": [
{
"group": "Getting Started",
"pages": [
"quickstart",
{
"group": "Nested Reference Pages",
"pages": ["nested-reference-page"]
}
]
}
]
```
</CodeGroup>

### Hidden Pages
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 All @@ -238,4 +235,4 @@ repository. Use the `topbarCtaButton` field with the `type` set to `github`.
"type": "github",
"url": "https://github.com/mintlify/docs"
}
```
```

0 comments on commit 2e3857e

Please sign in to comment.