From 448b5a9415edab83bb7d4612d05d2d96ee6ddf8e Mon Sep 17 00:00:00 2001 From: flo merian Date: Thu, 7 Nov 2024 10:29:51 +0100 Subject: [PATCH 1/3] Fix `topbarCtaButton` prop requirements in Global Settings --- settings/global.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/settings/global.mdx b/settings/global.mdx index 6ce19ff..a407f18 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -259,16 +259,16 @@ settings. Learn more about the [properties](#properties) or from an - - Link shows a button. GitHub shows the repo information at the url provided - including the number of GitHub stars. + + Text inside the button. Only required if type is a link. - + If type is a link: What the button links to. If type is a github: Link to the repository to load GitHub information from. - - Text inside the button. Only required if type is a link. + + Link shows a button. GitHub shows the repo information at the url provided + including the number of GitHub stars. The style of the button. From da1ef88abeb19105333e3788d8fc3a01825dc155 Mon Sep 17 00:00:00 2001 From: flo merian Date: Thu, 7 Nov 2024 10:35:43 +0100 Subject: [PATCH 2/3] Fix `topbarCtaButton` prop in Navigation --- settings/global.mdx | 6 +++--- settings/navigation.mdx | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/settings/global.mdx b/settings/global.mdx index a407f18..9ca1171 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -259,13 +259,13 @@ settings. Learn more about the [properties](#properties) or from an - - Text inside the button. Only required if type is a link. - If type is a link: What the button links to. If type is a github: Link to the repository to load GitHub information from. + + Text inside the button. Only required if type is a link. + Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. diff --git a/settings/navigation.mdx b/settings/navigation.mdx index 6bcb151..6447be9 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -208,23 +208,23 @@ 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. -The `topbarCTA` field supports the following fields: `name`, `url`, and `type`. +The `topbarCtaButton` field supports the following fields: `name`, `url`, `type`, `style`, and `arrow`. ```json - "topbarCTA": { + "topbarCtaButton": { "name": "Get Started", "url": "https://mintlify.com/get-started" } ``` -#### Github +#### GitHub You can also configure the CTA button to link directly to your GitHub repository. Use the `topbarCtaButton` field with the `type` set to `github`. From 8e5959b7b635d2b00fbc89dcf8f2c946a81624d1 Mon Sep 17 00:00:00 2001 From: flo merian Date: Thu, 7 Nov 2024 11:50:23 +0100 Subject: [PATCH 3/3] Fix `topbarLinks` prop requirements in Global Settings --- settings/global.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/settings/global.mdx b/settings/global.mdx index 9ca1171..e930993 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -222,7 +222,7 @@ settings. Learn more about the [properties](#properties) or from an ### Structure - An array of groups with all the pages within that group + An array of groups with all the pages within that group. The name of the group. @@ -245,12 +245,12 @@ settings. Learn more about the [properties](#properties) or from an - Array of names and urls of links you want to include in the topbar + Array of names and urls of links you want to include in the topbar. - + The name of the button. - + The url once you click on the button. Example: `https://mintlify.com/contact`