11---
22title : ' Custom Scripts'
3- description : ' Fully customize your documentation with custom CSS & JS'
3+ description : ' Fully customize your documentation with custom CSS and JS'
44icon : " code"
55---
66
7- Add custom CSS & JS to your documentation to fully customize the look and feel.
7+ Add custom CSS and JavaScript to your documentation to fully customize the look and feel.
88
99## Custom CSS
1010
11- Add any number of CSS files to your repository and the defined class names will be applied and available across all of your MDX files.
11+ Add CSS files to your repository and their defined class names will be applied and available in all of your ` MDX ` files.
1212
13- ### Adding style.css
13+ ### Adding ` style.css `
1414
1515For example, you can add the following ` style.css ` file to customize the styling of the navbar and footer.
1616
@@ -25,27 +25,127 @@ footer {
2525}
2626```
2727
28- ### Using Identifiers
28+ ### Using identifiers and selectors
2929
30- Mintlify has a set of common identifiers to help you tag important elements of the UI. Some, but not all are listed in the following:
31-
32- ` #topbar-cta-button ` ` #navbar ` ` #sidebar ` ` #content-area ` ` #table-of-contents `
30+ Mintlify has a set of common identifiers and selectors to help you tag important elements of the UI.
3331
3432<Tip >
35- Use inspect element to find references to elements you're looking to
36- customize.
33+ Use inspect element to find references to elements you're looking to customize.
3734</Tip >
3835
36+ <AccordionGroup >
37+ <Accordion title = " Identifiers" >
38+ - APIPlaygroundInput: ` api-playground-input `
39+ - AssistantEntry: ` assistant-entry `
40+ - AssistantEntryMobile: ` assistant-entry-mobile `
41+ - Banner: ` banner `
42+ - ChangelogFilters: ` changelog-filters `
43+ - ChangelogFiltersContent: ` changelog-filters-content `
44+ - ChatAssistantSheet: ` chat-assistant-sheet `
45+ - ChatAssistantTextArea: ` chat-assistant-textarea `
46+ - ContentArea: ` content-area `
47+ - ContentContainer: ` content-container `
48+ - ContentSideLayout: ` content-side-layout `
49+ - Footer: ` footer `
50+ - Header: ` header `
51+ - NavBarTransition: ` navbar-transition `
52+ - NavigationItems: ` navigation-items `
53+ - Navbar: ` navbar `
54+ - PageContextMenu: ` page-context-menu `
55+ - PageContextMenuButton: ` page-context-menu-button `
56+ - PageTitle: ` page-title `
57+ - Pagination: ` pagination `
58+ - Panel: ` panel `
59+ - RequestExample: ` request-example `
60+ - ResponseExample: ` response-example `
61+ - SearchBarEntry: ` search-bar-entry `
62+ - SearchBarEntryMobile: ` search-bar-entry-mobile `
63+ - SearchInput: ` search-input `
64+ - Sidebar: ` sidebar `
65+ - SidebarContent: ` sidebar-content `
66+ - TableOfContents: ` table-of-contents `
67+ - TableOfContentsContent: ` table-of-contents-content `
68+ - TableOfContentsLayout: ` table-of-contents-layout `
69+ - TopbarCtaButton: ` topbar-cta-button `
70+ </Accordion >
71+ <Accordion title = " Selectors" >
72+ - Accordion: ` accordion `
73+ - AccordionGroup: ` accordion-group `
74+ - AlmondLayout: ` almond-layout `
75+ - AlmondNavBottomSection: ` almond-nav-bottom-section `
76+ - AlmondNavBottomSectionDivider: ` almond-nav-bottom-section-divider `
77+ - Anchor: ` nav-anchor `
78+ - Anchors: ` nav-anchors `
79+ - APISection: ` api-section `
80+ - APISectionHeading: ` api-section-heading `
81+ - APISectionHeadingSubtitle: ` api-section-heading-subtitle `
82+ - APISectionHeadingTitle: ` api-section-heading-title `
83+ - Callout: ` callout `
84+ - Card: ` card `
85+ - CardGroup: ` card-group `
86+ - ChatAssistantSheet: ` chat-assistant-sheet `
87+ - ChatAssistantSheetHeader: ` chat-assistant-sheet-header `
88+ - ChatAssistantSheetContent: ` chat-assistant-sheet-content `
89+ - ChatAssistantInput: ` chat-assistant-input `
90+ - ChatAssistantSendButton: ` chat-assistant-send-button `
91+ - CodeBlock: ` code-block `
92+ - CodeGroup: ` code-group `
93+ - Content: ` mdx-content `
94+ - DropdownTrigger: ` nav-dropdown-trigger `
95+ - DropdownContent: ` nav-dropdown-content `
96+ - DropdownItem: ` nav-dropdown-item `
97+ - DropdownItemTextContainer: ` nav-dropdown-item-text-container `
98+ - DropdownItemTitle: ` nav-dropdown-item-title `
99+ - DropdownItemDescription: ` nav-dropdown-item-description `
100+ - DropdownItemIcon: ` nav-dropdown-item-icon `
101+ - Expandable: ` expandable `
102+ - Eyebrow: ` eyebrow `
103+ - FeedbackToolbar: ` feedback-toolbar `
104+ - Field: ` field `
105+ - Frame: ` frame `
106+ - Icon: ` icon `
107+ - Link: ` link `
108+ - LoginLink: ` login-link `
109+ - Logo: ` nav-logo `
110+ - Mermaid: ` mermaid `
111+ - MethodNavPill: ` method-nav-pill `
112+ - MethodPill: ` method-pill `
113+ - NavBarLink: ` navbar-link `
114+ - NavTagPill: ` nav-tag-pill `
115+ - NavTagPillText: ` nav-tag-pill-text `
116+ - OptionDropdown: ` option-dropdown `
117+ - PaginationNext: ` pagination-next `
118+ - PaginationPrev: ` pagination-prev `
119+ - PaginationTitle: ` pagination-title `
120+ - Panel: ` panel `
121+ - SidebarGroup: ` sidebar-group `
122+ - SidebarGroupIcon: ` sidebar-group-icon `
123+ - SidebarGroupHeader: ` sidebar-group-header `
124+ - SidebarTitle: ` sidebar-title `
125+ - Step: ` step `
126+ - Steps: ` steps `
127+ - Tab: ` tab `
128+ - Tabs: ` tabs `
129+ - TabsBar: ` nav-tabs `
130+ - TabsBarItem: ` nav-tabs-item `
131+ - TableOfContents: ` toc `
132+ - TableOfContentsItem: ` toc-item `
133+ - Tooltip: ` tooltip `
134+ - TopbarRightContainer: ` topbar-right-container `
135+ - TryitButton: ` tryit-button `
136+ - Update: ` update `
137+ </Accordion >
138+ </AccordionGroup >
139+
39140<Warning >
40- References and the styling of common elements are subject to change as the
41- platform evolves. Please use custom styling with caution.
141+ References and the styling of common elements are subject to change as the platform evolves. Please use custom styling with caution.
42142</Warning >
43143
44- ## Custom JS
144+ ## Custom JavaScript
45145
46146Custom JS allows you to add custom executable code globally. It is the equivalent of adding a ` <script> ` tag with JS code into every page.
47147
48- ### Adding Custom JavaScript
148+ ### Adding custom JavaScript
49149
50150Any ` .js ` file inside the content directory of your docs will be included in every documentation page. For example, you can add the following ` ga.js ` file to enable [ Google Analytics] ( https://marketingplatform.google.com/about/analytics ) across the entire documentation.
51151
0 commit comments