From 7b1a723d4d0e1eff1c94a9b167f1c0a025b750bf Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Mon, 15 Dec 2025 13:27:31 -0800 Subject: [PATCH 1/5] Update components.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- components.mdx | 104 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 components.mdx diff --git a/components.mdx b/components.mdx new file mode 100644 index 000000000..90914c15f --- /dev/null +++ b/components.mdx @@ -0,0 +1,104 @@ +--- +title: "Components" +description: "Enhance your documentation with interactive and visual components." +--- + +Mintlify provides a library of built-in components to make your documentation more engaging and easier to navigate. Use these components to organize content, highlight important information, and create interactive experiences. + +## Content organization + + + Expandable sections for progressive disclosure of content. + + + + Organize related content into switchable tabbed views. + + + + Display sequential instructions in a numbered format. + + + + Arrange content side by side in responsive layouts. + + +## Visual elements + + + Highlight content with customizable containers and icons. + + + + Emphasize important information with styled alerts. + + + + Add borders and styling to images and content. + + + + Add visual indicators using the Lucide icon library. + + +## Interactive elements + + + Display additional information on hover. + + + + Show and hide detailed content on demand. + + + + Display multiple code examples in tabbed views. + + +## Data display + + + Document API response structures and fields. + + + + Display parameter and property definitions. + + + + Show request and response examples side by side. + + +## Specialized components + + + Create flowcharts, sequence diagrams, and more. + + + + Display content in a grid of clickable tiles. + + + + Create sidebar panels for supplementary content. + + + + Display prominent announcements at the top of pages. + + + + Add inline labels and status indicators. + + + + Display color swatches with hex values. + + + + Highlight new or updated content. + + + + Conditionally show content based on context. + From 1556fa9be897c174a778ebc2ad4539b024c3bb5d Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Mon, 15 Dec 2025 13:27:38 -0800 Subject: [PATCH 2/5] Update docs.json Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- docs.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs.json b/docs.json index d4fb3861f..3261308bb 100644 --- a/docs.json +++ b/docs.json @@ -27,6 +27,7 @@ "pages": [ "index", "quickstart", + "components", "installation", "editor", "ai-native", From d6fd4224aa9f4b64097a2df4ff9041ce5614f672 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Dec 2025 10:23:07 -0800 Subject: [PATCH 3/5] rename page index.mdx --- components.mdx => components/index.mdx | 0 docs.json | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename components.mdx => components/index.mdx (100%) diff --git a/components.mdx b/components/index.mdx similarity index 100% rename from components.mdx rename to components/index.mdx diff --git a/docs.json b/docs.json index 3261308bb..ba4a82c33 100644 --- a/docs.json +++ b/docs.json @@ -27,7 +27,6 @@ "pages": [ "index", "quickstart", - "components", "installation", "editor", "ai-native", @@ -76,6 +75,7 @@ { "group": "Components", "pages": [ + "components/index", "components/accordions", "components/badge", "components/banner", From 2be0c3746b3da49d37376a49a4a6acf920d89e54 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Dec 2025 10:51:32 -0800 Subject: [PATCH 4/5] structure around intent --- components/index.mdx | 82 +++++++++++++++++++++++--------------------- 1 file changed, 42 insertions(+), 40 deletions(-) diff --git a/components/index.mdx b/components/index.mdx index 90914c15f..f3f073f0b 100644 --- a/components/index.mdx +++ b/components/index.mdx @@ -1,20 +1,20 @@ --- -title: "Components" +title: "Overview" description: "Enhance your documentation with interactive and visual components." --- Mintlify provides a library of built-in components to make your documentation more engaging and easier to navigate. Use these components to organize content, highlight important information, and create interactive experiences. -## Content organization - - - Expandable sections for progressive disclosure of content. - +## Structure your content Organize related content into switchable tabbed views. + + Display code examples in multiple languages. + + Display sequential instructions in a numbered format. @@ -23,82 +23,84 @@ Mintlify provides a library of built-in components to make your documentation mo Arrange content side by side in responsive layouts. -## Visual elements - - - Highlight content with customizable containers and icons. + + Create sidebar panels for supplementary content. +## Draw attention + Emphasize important information with styled alerts. - - Add borders and styling to images and content. + + Display prominent announcements at the top of pages. - - Add visual indicators using the Lucide icon library. + + Add inline labels and status indicators. -## Interactive elements + + Highlight new or updated content. + + + + Add borders and styling to images and content. + Display additional information on hover. +## Show and hide content + + + Expandable sections for progressive disclosure of content. + + Show and hide detailed content on demand. - - Display multiple code examples in tabbed views. + + Conditionally show content based on context. -## Data display - - - Document API response structures and fields. - +## Document your API Display parameter and property definitions. + + Document API response structures and fields. + + Show request and response examples side by side. -## Specialized components +## Link to other pages - - Create flowcharts, sequence diagrams, and more. + + Highlight content with customizable containers and icons. Display content in a grid of clickable tiles. - - Create sidebar panels for supplementary content. - +## Add visual context - - Display prominent announcements at the top of pages. + + Add visual indicators using the Lucide icon library. - - Add inline labels and status indicators. + + Create flowcharts, sequence diagrams, and more. Display color swatches with hex values. - - - Highlight new or updated content. - - - - Conditionally show content based on context. - From 43c19e21d72ea2e210e68ba55ee2ae6a7bc597dd Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Dec 2025 10:54:08 -0800 Subject: [PATCH 5/5] update intro --- components/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/index.mdx b/components/index.mdx index f3f073f0b..e06a4dc56 100644 --- a/components/index.mdx +++ b/components/index.mdx @@ -1,9 +1,9 @@ --- title: "Overview" -description: "Enhance your documentation with interactive and visual components." +description: "Component library for layout, emphasis, API documentation, and navigation." --- -Mintlify provides a library of built-in components to make your documentation more engaging and easier to navigate. Use these components to organize content, highlight important information, and create interactive experiences. +Mintlify provides built-in MDX components for your documentation pages. Use these components to structure content, draw attention to important information, document APIs, and guide navigation. ## Structure your content