Style with Tailwind CSS
Use Tailwind CSS v3 to style HTML elements. You can control layout, spacing, colors, and other visual properties. Some common classes are:w-full- Full widthaspect-video- 16:9 aspect ratiorounded-xl- Large rounded cornersblock,hidden- Display controldark:hidden,dark:block- Dark mode visibility
style prop instead.
Add custom CSS
Add CSS files to your repository to apply their defined class names and make them available in all of your MDX files. The references and styling of common elements are subject to change. Use custom styling with caution since breaking changes may occur in future updates. For example, you can add the followingstyle.css file to customize the styling of the navbar and footer.
- ID selectors: unique page-level elements targeted with
#value { }in CSS - Element selectors: component and layout elements targeted with
value { }in CSS (no#or.prefix)
ID selectors
Each ID appears once per page. Use these as#value in CSS. For example, #navbar { background: red; }.
Page layout
Page layout
#body-content— Outermost wrapper for the page body.#content-area— Primary content area, excluding the sidebar and table of contents.#content— Inner content element within the content area.#header— Page-level header element.#banner— Announcement banner displayed above the navbar.#footer— Page footer. Also targetable as an element selector:footer.#page-title— The<h1>heading at the top of each page.#pagination— Bottom pagination bar with previous and next page links.#panel— Floating panel overlay. Also targetable as an element selector:panel.#background-color— Page background color element.
Navigation
Navigation
Sidebar
Sidebar
Table of contents
Table of contents
#table-of-contents— Table of contents panel on the right side of the page.#table-of-contents-layout— Layout wrapper for the table of contents.#table-of-contents-content— Scrollable content within the table of contents.
Search
Search
#search-bar-entry— Search bar trigger in the topbar.#search-bar-entry-mobile— Search bar trigger on mobile.#search-input— Text input field within the search modal.
AI assistant
AI assistant
#assistant-entry— AI assistant button in the topbar.#assistant-entry-mobile— AI assistant button on mobile.#chat-assistant-sheet— AI assistant chat panel.#chat-assistant-textarea— Text input within the AI assistant panel.
API reference
API reference
#request-example— Request example panel in the API playground.#response-example— Response example panel in the API playground.#api-playground-input— Input section of the API playground.#endpoints-menu-trigger— Button that opens the endpoint selector dropdown.
Code blocks
Code blocks
#ask-ai-code-block-button— “Ask AI” button that appears on code blocks.#code-snippet-feedback-button— Feedback button on code snippets.#code-snippet-feedback-textarea— Text area within the code snippet feedback form.
Feedback
Feedback
#feedback-thumbs-up— Thumbs-up feedback button at the bottom of a page.#feedback-thumbs-down— Thumbs-down feedback button at the bottom of a page.#feedback-form— Feedback form shown after a thumbs-down response.#feedback-form-input— Text input within the feedback form.#feedback-form-cancel— Cancel button within the feedback form.#feedback-form-submit— Submit button within the feedback form.
Page context menu
Page context menu
Localization
Localization
#localization-select-trigger— Button that opens the language selector.#localization-select-content— Dropdown content of the language selector.#localization-select-item— Individual language option within the selector.
Changelog
Changelog
#changelog-filters— Filter controls on a changelog page.#changelog-filters-content— Content area within the changelog filter panel.
Multi-view
Multi-view
#multi-view-dropdown— Dropdown for switching between documentation views.
Text selection
Text selection
#text-selection-tooltip— Tooltip that appears when text is selected on a page.#text-selection-tooltip-button— Action button within the text selection tooltip.
Element selectors
Multiple instances of these elements can appear on a page. Use these asvalue in CSS. For example, accordion { border: 1px solid red; }.
Content components
Content components
accordion— Collapsible accordion item.accordion-group— Wrapper grouping multiple accordions.callout— Callout block (Note, Warning, Tip, etc.).card— Individual card element.card-group— Wrapper grouping multiple cards. Deprecated in favor ofcolumns, but preserved for backward compatibility.columns— Multi-column layout wrapper.code-block— Code block element.code-block-icon— Icon displayed in a code block header.code-group— Tabbed group of code blocks.expandable— Expandable section element.frame— Frame wrapper for images or embedded content.icon— Inline icon element.mermaid— Mermaid diagram wrapper.step— Individual step within a steps sequence.steps— Numbered steps container.tab-icon— Icon displayed within a tab.tabs— Tabbed content container.tile— Tile component element.tooltip— Tooltip element.update— Changelog update entry.
Page layout
Page layout
mdx-content— Rendered MDX content area.panel— Floating panel component. Also targetable as an ID selector:#panel.eyebrow— Small label displayed above a page title.link— Anchor link element.breadcrumb-list— Breadcrumb navigation list.breadcrumb-item— Individual breadcrumb item.
Topbar navigation
Topbar navigation
Topbar dropdown
Topbar dropdown
nav-dropdown-trigger— Button that opens a navigation dropdown.nav-dropdown-content— Content container for a navigation dropdown.nav-dropdown-item— Individual item within a navigation dropdown.nav-dropdown-item-text-container— Text wrapper within a dropdown item.nav-dropdown-item-title— Title text within a dropdown item.nav-dropdown-item-description— Description text within a dropdown item.nav-dropdown-item-icon— Icon within a dropdown item.
Products selector
Products selector
nav-dropdown-products-selector-trigger— Button that opens the products selector dropdown.nav-dropdown-products-selector-content— Content container for the products selector.nav-dropdown-products-selector-item— Individual product in the selector.nav-dropdown-products-selector-item-title— Title of a product selector item.nav-dropdown-products-selector-item-description— Description of a product selector item.nav-dropdown-products-selector-item-icon— Icon of a product selector item.
Sidebar
Sidebar
Table of contents
Table of contents
toc— Table of contents container.toc-item— Individual heading entry in the table of contents.
Footer
Footer
Pagination
Pagination
pagination-prev— Previous page link in the pagination bar.pagination-next— Next page link in the pagination bar.pagination-title— Page title shown in the pagination bar.
API reference
API reference
api-section— Full section for a single API endpoint.api-section-heading— Heading area for an API endpoint section.api-section-heading-title— Title within an API endpoint section heading.api-section-heading-subtitle— Subtitle within an API endpoint section heading.field— Parameter or property field in the API reference.option-dropdown— Dropdown for selecting between API options.tryit-button— “Try it” button that opens the API playground.method-pill— HTTP method badge (GET, POST, etc.) on an endpoint.method-nav-pill— HTTP method badge shown in the sidebar navigation.prompt— Prompt component in the API reference.
AI assistant
AI assistant
chat-assistant-sheet— AI assistant panel container.chat-assistant-sheet-header— Header of the AI assistant panel.chat-assistant-sheet-content— Content area of the AI assistant panel.chat-assistant-input— Text input within the AI assistant panel.chat-assistant-floating-input— Floating input variant of the AI assistant.chat-assistant-send-button— Send button in the AI assistant panel.chat-assistant-disclaimer-text— Disclaimer text displayed in the AI assistant panel.chat-assistant-payload-item— Individual message or result item in the assistant panel.starter-question-text— Suggested starter question shown in an empty assistant panel.
Feedback
Feedback
feedback-toolbar— Toolbar containing page feedback controls.contextual-feedback-container— Container for contextual inline feedback.contextual-feedback-form— Inline contextual feedback form.contextual-feedback-form-title— Title of the contextual feedback form.contextual-feedback-input— Text input within the contextual feedback form.contextual-feedback-button— Action button within the contextual feedback form.contextual-feedback-form-submit-button— Submit button for the contextual feedback form.
Code snippet feedback
Code snippet feedback
code-snippet-feedback-popover-content— Popover content for code snippet feedback.code-snippet-feedback-form— Feedback form for a code snippet.code-snippet-feedback-textarea— Text area within the code snippet feedback form.code-snippet-feedback-form-title— Title of the code snippet feedback form.code-snippet-feedback-form-description— Description text in the code snippet feedback form.code-snippet-feedback-form-submit-button— Submit button for the code snippet feedback form.
Authentication
Authentication
login-link— Link that initiates the login flow.logout-link— Link that initiates the logout flow.
Multi-view
Multi-view
multi-view-item— Individual view option in a multi-view switcher.multi-view-dropdown— Dropdown for selecting between multiple views.multi-view-dropdown-trigger— Button that opens the multi-view dropdown.multi-view-dropdown-content— Content area of the multi-view dropdown.multi-view-dropdown-item— Individual item within the multi-view dropdown.
Directory
Directory
directory— Root container for a directory page.directory-group— Group of related pages within a directory.directory-page— Individual page entry in a directory.directory-card— Card-style page entry in a directory.
404 page
404 page
not-found-container— Root container of the 404 page.not-found-status-code— Status code display on the 404 page.not-found-title— Title heading on the 404 page.not-found-description— Description text on the 404 page.not-found-recommended-pages-list— List of recommended pages shown on the 404 page.not-found-recommended-page-link— Individual link in the recommended pages list.
Color
Color
color— Color swatch element.color-row— Row grouping color swatches.color-item— Individual color item within a color row.
Tree
Tree
tree— File tree container.tree-folder— Folder entry within a file tree.tree-file— File entry within a file tree.
Data attributes
Data attributes
Some elements expose data attributes you can use as CSS selectors.Active state (
data-active):nav-dropdown-item[data-active]— Active item in a nav dropdown.mobile-nav-tabs-item[data-active]— Active tab in the mobile nav.sidebar-group[data-active]— Active sidebar group.#sidebar-content li[data-active]— Active sidebar link..nav-tabs-item[data-active]— Active top nav tab. Only applies to simple tabs; tabs with dropdown menus do not receivedata-active. Note the leading.: this targets a class on a standard<a>element, unlike most other components which use custom element names.toc-item[data-active]— Active table of contents item.toc-item[data-active-deepest]— Deepest active table of contents item. Only present on the exact heading currently in view, unlikedata-activewhich is also set on its parent headings.
data-component-name):Use data-component-name to target specific UI components with a stable selector that persists if internal class names change.[data-component-name="mermaid-container"]— Mermaid diagram wrapper, including the zoom controls overlay.[data-component-name="mermaid-controls-wrapper"]— Mermaid zoom and pan controls.[data-component-name="primary-header-button"]— Primary header button. Sequoia theme only.[data-component-name="theme-toggle"]— Theme toggle.
data-component-part):Use data-component-part to target sub-elements within a component.[data-component-part="contact-support-button"]— The<a>wrapper around the contact support link in the assistant panel.[data-component-part="contact-support-icon"]— The<span>wrapping the icon.[data-component-part="contact-support-text"]— The<p>element containing the label.
[data-badge]— Any badge element.[data-badge][data-color="blue"]— Badge filtered by color.[data-badge][data-size="sm"]— Badge filtered by size.
Custom JavaScript
Custom JS allows you to add custom executable code globally. It is the equivalent of adding a<script> tag with JS code into every page.
Mintlify includes any .js file inside your content directory on every page of your documentation site. For example, you can add the following ga.js file to enable Google Analytics across the entire documentation.