Skip to content

Update from code changes: document className prop on components - #7165

Open
mintlify[bot] wants to merge 5 commits into
mainfrom
mintlify/0e417ed8
Open

Update from code changes: document className prop on components#7165
mintlify[bot] wants to merge 5 commits into
mainfrom
mintlify/0e417ed8

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

All MDX components now accept an optional className prop that is merged onto the component's outer element, bringing components like Accordion, Steps, callouts, Tab, ParamField, and Tooltip in line with Card, Columns, and Badge, which already supported it. This makes it possible to style any component with Tailwind CSS or custom CSS classes without extra wrapper markup. Banner is config-driven and unchanged.

Shipped in https://github.com/mintlify/mint/pull/10540

Changes

  • Added a "Style components" section to the components overview explaining the universal className prop with an example.
  • Noted className support with an example in the Tailwind CSS styling section of the custom scripts page.
  • Mirrored both changes in the es, fr, and zh translations.
  • Tweaked skill.md to mention the className prop for component styling.

Update history

  • Initial run: documented the universal className prop (components overview, custom scripts page, es/fr/zh translations, skill.md) for https://github.com/mintlify/mint/pull/10540.
  • Best-practices pass: kept code block titles in English on translated pages.
  • Reviewed https://github.com/mintlify/mint/pull/6737 (Tailwind class prefixing now works for className on MDX components): internal fix that makes the already-documented behavior work; no docs content change needed.

Note

Low Risk
Documentation-only changes with no runtime or security impact; the stray quickstart accordion is a content-quality issue, not a product risk.

Overview
Documents that all MDX components now accept an optional className prop whose classes are merged onto the outer element, with examples using Tailwind or custom CSS.

Adds a Style components section on the English and localized (es, fr, zh) components overview pages, mirrors the same guidance in Tailwind CSS on custom-scripts, and updates skill.md so agents prefer className (or custom.css) for layout tweaks.

Incidental edits: ai-native.mdx reformats frontmatter keywords, wraps the Reading/assistant copy in an <Accordion>, and adds Automations and Contextual menu cards to the enable-AI card group. quickstart.mdx uses the same keywords list format, trims blank lines in the agent-only setup steps, and adds a test <Accordion title="robert"> block at the top that looks unintentional and should be removed before merge.

Reviewed by Cursor Bugbot for commit 682a059. Bugbot is set up for automated code reviews on this repo. Configure here.

Mintlify

1 thread from 1 user in Mintlify

Review in Mintlify

@mintlify

mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 28, 2026, 2:01 AM

@mintlify

mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 28, 2026, 2:00 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

- Updated quickstart.mdx

Mintlify-Source: dashboard-editor
Comment thread quickstart.mdx

<Accordion title="robert">
team is awesome
</Accordion>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accidental test content on Quickstart

High Severity

A leftover Accordion with the title robert and the body team is awesome was added at the top of quickstart.mdx. This personal test content is unrelated to the page and will appear to every visitor on the main getting-started docs.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit cd5c010. Configure here.

mintlify Bot added 2 commits August 31, 2026 23:09
- Updated ai-native.mdx

Mintlify-Source: dashboard-editor
- Updated ai-native.mdx

Mintlify-Source: dashboard-editor

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

There are 2 total unresolved issues (including 1 from previous review).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 682a059. Configure here.

Comment thread ai-native.mdx
In addition to reading individual pages, users can chat with the [assistant](/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](/api/assistant/create-assistant-message-v2) to extend where users can access your documentation.
<Accordion title="Assistant">
In addition to reading individual pages, users can chat with the [assistant](/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](/api/assistant/create-assistant-message-v2) to extend where users can access your documentation.
</Accordion>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accidental accordion hides reading content

Medium Severity

The Reading section body is wrapped in an Accordion titled Assistant, while the sibling Writing and Discovering sections remain as regular paragraphs. This looks like leftover test markup and hides the assistant overview behind a collapsed panel on a primary docs page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 682a059. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants