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 JavScript 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,100 @@ 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+ - Banner: ` banner `
39+ - ChangelogFilters: ` changelog-filters `
40+ - ChangelogFiltersContent: ` changelog-filters-content `
41+ - ContentArea: ` content-area `
42+ - ContentContainer: ` content-container `
43+ - ContentSideLayout: ` content-side-layout `
44+ - Footer: ` footer `
45+ - Header: ` header `
46+ - NavBarTransition: ` navbar-transition `
47+ - NavigationItems: ` navigation-items `
48+ - Navbar: ` navbar `
49+ - PageContextMenu: ` page-context-menu `
50+ - PageContextMenuButton: ` page-context-menu-button `
51+ - PageTitle: ` page-title `
52+ - Pagination: ` pagination `
53+ - Panel: ` panel `
54+ - RequestExample: ` request-example `
55+ - ResponseExample: ` response-example `
56+ - SearchBarEntry: ` search-bar-entry `
57+ - SearchBarEntryMobile: ` search-bar-entry-mobile `
58+ - Sidebar: ` sidebar `
59+ - SidebarContent: ` sidebar-content `
60+ - TableOfContents: ` table-of-contents `
61+ - TableOfContentsContent: ` table-of-contents-content `
62+ - TableOfContentsLayout: ` table-of-contents-layout `
63+ - TopbarCtaButton: ` topbar-cta-button `
64+ </Accordion >
65+ <Accordion title = " Selectors" >
66+ - Accordion: ` accordion `
67+ - AccordionGroup: ` accordion-group `
68+ - Anchor: ` nav-anchor `
69+ - Anchors: ` nav-anchors `
70+ - APISection: ` api-section `
71+ - APISectionHeading: ` api-section-heading `
72+ - APISectionHeadingSubtitle: ` api-section-heading-subtitle `
73+ - APISectionHeadingTitle: ` api-section-heading-title `
74+ - Callout: ` callout `
75+ - Card: ` card `
76+ - CardGroup: ` card-group `
77+ - CodeBlock: ` code-block `
78+ - CodeGroup: ` code-group `
79+ - Content: ` mdx-content `
80+ - Expandable: ` expandable `
81+ - Eyebrow: ` eyebrow `
82+ - FeedbackToolbar: ` feedback-toolbar `
83+ - Field: ` field `
84+ - Frame: ` frame `
85+ - Icon: ` icon `
86+ - Link: ` link `
87+ - Logo: ` nav-logo `
88+ - Mermaid: ` mermaid `
89+ - MethodNavPill: ` method-nav-pill `
90+ - MethodPill: ` method-pill `
91+ - NavBarLink: ` navbar-link `
92+ - OptionDropdown: ` option-dropdown `
93+ - PaginationNext: ` pagination-next `
94+ - PaginationPrev: ` pagination-prev `
95+ - PaginationTitle: ` pagination-title `
96+ - Panel: ` panel `
97+ - SidebarGroup: ` sidebar-group `
98+ - SidebarTitle: ` sidebar-title `
99+ - Step: ` step `
100+ - Steps: ` steps `
101+ - Tab: ` tab `
102+ - Tabs: ` tabs `
103+ - TabsBar: ` nav-tabs `
104+ - TabsBarItem: ` nav-tabs-item `
105+ - TableOfContents: ` toc `
106+ - TableOfContentsItem: ` toc-item `
107+ - Tooltip: ` tooltip `
108+ - TryitButton: ` tryit-button `
109+ - Update: ` update `
110+ </Accordion >
111+ </AccordionGroup >
112+
39113<Warning >
40- References and the styling of common elements are subject to change as the
41- platform evolves. Please use custom styling with caution.
114+ References and the styling of common elements are subject to change as the platform evolves. Please use custom styling with caution.
42115</Warning >
43116
44- ## Custom JS
117+ ## Custom JavaScript
45118
46119Custom JS allows you to add custom executable code globally. It is the equivalent of adding a ` <script> ` tag with JS code into every page.
47120
48- ### Adding Custom JavaScript
121+ ### Adding custom JavaScript
49122
50123Any ` .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.
51124
0 commit comments