diff --git a/components/index.mdx b/components/index.mdx new file mode 100644 index 000000000..e06a4dc56 --- /dev/null +++ b/components/index.mdx @@ -0,0 +1,106 @@ +--- +title: "Overview" +description: "Component library for layout, emphasis, API documentation, and navigation." +--- + +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 + + + Organize related content into switchable tabbed views. + + + + Display code examples in multiple languages. + + + + Display sequential instructions in a numbered format. + + + + Arrange content side by side in responsive layouts. + + + + Create sidebar panels for supplementary content. + + +## Draw attention + + + Emphasize important information with styled alerts. + + + + Display prominent announcements at the top of pages. + + + + Add inline labels and status indicators. + + + + 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. + + + + Conditionally show content based on context. + + +## Document your API + + + Display parameter and property definitions. + + + + Document API response structures and fields. + + + + Show request and response examples side by side. + + +## Link to other pages + + + Highlight content with customizable containers and icons. + + + + Display content in a grid of clickable tiles. + + +## Add visual context + + + Add visual indicators using the Lucide icon library. + + + + Create flowcharts, sequence diagrams, and more. + + + + Display color swatches with hex values. + diff --git a/docs.json b/docs.json index d4fb3861f..ba4a82c33 100644 --- a/docs.json +++ b/docs.json @@ -75,6 +75,7 @@ { "group": "Components", "pages": [ + "components/index", "components/accordions", "components/badge", "components/banner",