@veluai/velu 0.2.34 → 0.2.36

package/README.md

@@ -75,6 +75,45 @@ my-docs/
 
 Page labels come from each page's frontmatter `title`.
 
+## Custom CSS and JavaScript
+
+Every `.css` and `.js` file in the project folder (at any depth) is included on
+every page — nothing to configure. CSS is linked after the theme so your rules
+win; JS runs once per page load, after the page has hydrated. Dot-folders,
+`node_modules/`, `public/` and the build output are skipped.
+
+MDX also supports Tailwind utility classes on HTML elements
+(`className="w-full rounded-xl"`, `dark:hidden`, …) — they are scanned from the
+project and generated into the theme stylesheet.
+
+Selectors follow Mintlify's, so Mintlify custom CSS ports over:
+
+- **Ids** on the layout — `#navbar`, `#sidebar`, `#sidebar-content`, `#content`,
+  `#content-area`, `#table-of-contents`, `#pagination`, `#footer`,
+  `#search-bar-entry`, `#search-input`, `#assistant-entry`, `#topbar-cta-button`,
+  `#page-context-menu`, `#chat-assistant-sheet`, `#feedback-*`, `#request-example`,
+  `#response-example`, `#changelog-filters`, `#localization-select-*`, …
+- **Element selectors** — components render as the same tags Mintlify uses, so
+  `card { }`, `callout { }`, `code-block { }`, `steps { }`, `toc-item { }`,
+  `sidebar-group { }`, `mdx-content { }` … work as-is. Roots that must stay native
+  HTML (`<a>`, `<button>`, `<details>`…) carry `data-component` instead:
+  `[data-component="accordion"]`, `[data-component="nav-tabs-item"]`.
+- **State** — `html[data-theme="dark"]`, `html[data-current-path="/quickstart"]`,
+  and `[data-active]` on the active sidebar link, header tab, TOC item and
+  dropdown item.
+
+```css
+/* style.css */
+#navbar { background: #fffff2; }
+card { border-radius: 0; }
+html[data-theme="dark"] callout { border-color: #444; }
+```
+
+```js
+// analytics.js
+window.dataLayer = window.dataLayer || [];
+```
+
 ## License
 
 Proprietary. © Velu.