@umami/shiso 1.7.0 → 1.8.0

package/dist/components.js

@@ -0,0 +1,3 @@
+import { At as Info, Dt as Callout, Et as CardGroup, Ft as Button, It as Badge, Mt as Tip, Nt as Warning, Ot as Check, Pt as WarningBanner, Rt as Accordion, Tt as Card, _ as Tooltip, at as Tabs, bt as Columns, ct as ResponseField, dt as ParamField, ft as Icon, ht as Expandable, it as Tab, jt as Note, kt as Danger, lt as PropertiesTable, n as ZoomableImage, ot as Step, pt as Frame, st as Steps, ut as Param, xt as CodeGroup, yt as Column, zt as AccordionGroup } from "./chunks/docs.js";
+
+export { Accordion, AccordionGroup, Badge, Button, Callout, Card, CardGroup, Check, CodeGroup, Column, Columns, Danger, Expandable, Frame, Icon, Info, Note, Param, ParamField, PropertiesTable, ResponseField, Step, Steps, Tab, Tabs, Tip, Tooltip, Warning, WarningBanner, ZoomableImage };

package/dist/entry-client.js

@@ -1,4 +1,5 @@
-import { g as BrowserRouter, m as BASE_URL, t as App } from "./chunks/App.js";
+import { ir as BrowserRouter } from "./chunks/docs.js";
+import { m as BASE_URL, t as App } from "./chunks/App.js";
 import { jsx } from "react/jsx-runtime";
 
 //#region src/entry-client.tsx

package/dist/entry-server.js

@@ -1,4 +1,5 @@
-import { _ as Router, a as docsSite, b as ABSOLUTE_URL_REGEX, c as getSeo, d as getDocModule, f as getLastModified, h as toAbsoluteUrl, i as docsHomeUrl, l as siteName, m as BASE_URL, n as buildHead, o as getLocaleByPathname, p as getScopeForPage, r as renderHeadToString, s as getRedirects, t as App, u as standalonePages, v as createPath, y as parsePath } from "./chunks/App.js";
+import { cr as Router, fr as createPath, mr as ABSOLUTE_URL_REGEX, pr as parsePath } from "./chunks/docs.js";
+import { a as docsSite, c as getSeo, d as getDocModule, f as getLastModified, h as toAbsoluteUrl, i as docsHomeUrl, l as siteName, m as BASE_URL, n as buildHead, o as getLocaleByPathname, p as getScopeForPage, r as renderHeadToString, s as getRedirects, t as App, u as standalonePages } from "./chunks/App.js";
 import * as React$1 from "react";
 import { jsx } from "react/jsx-runtime";
 import { renderToString } from "react-dom/server";
@@ -91,16 +92,17 @@ function getRoutes() {
 	return [...docsSite.pages.map((page) => page.url), ...standalonePages.map((page) => page.path)];
 }
 /**
-* Source file for every routed page, so the prerenderer can publish raw
+* Source file for every Markdown/MDX page, so the prerenderer can publish raw
 * markdown next to each HTML page (used by the contextual menu's copy/view
-* options and by AI tools). `filePath` is a module key like
-* "/content/docs/index.mdx", resolved against the project root.
+* options and by AI tools). TSX standalone pages have no raw Markdown copy.
+* `filePath` is a module key like "/content/docs/index.mdx", resolved against
+* the project root.
 */
 function getMarkdownPages() {
 	return [...docsSite.pages.map((page) => ({
 		route: page.url,
 		filePath: page.filePath
-	})), ...standalonePages.map((page) => ({
+	})), ...standalonePages.filter((page) => !page.filePath.endsWith(".tsx")).map((page) => ({
 		route: page.path,
 		filePath: page.filePath
 	}))];

package/docs.schema.json

@@ -99,7 +99,7 @@
           },
           "page": {
             "allOf": [{ "$ref": "#/definitions/nonEmptyStringValue" }],
-            "description": "File slug under content/pages, e.g. \"home\" for content/pages/home.mdx."
+            "description": "File slug under content/pages, e.g. \"home\" for content/pages/home.tsx, home.mdx, or home.md."
           },
           "title": {
             "allOf": [{ "$ref": "#/definitions/stringValue" }],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umami/shiso",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Open-source documentation framework for Markdown and MDX sites.",
   "type": "module",
   "bin": {
@@ -15,6 +15,10 @@
       "types": "./types/client.d.ts",
       "default": "./dist/entry-client.js"
     },
+    "./components": {
+      "types": "./types/components.d.ts",
+      "default": "./dist/components.js"
+    },
     "./search": {
       "types": "./types/search.d.ts",
       "default": "./dist/search.js"

package/scripts/build-runtime.mjs

@@ -66,6 +66,7 @@ const bundle = await rolldown({
   input: {
     'entry-client': path.join(sourceRoot, 'entry-client.tsx'),
     'entry-server': path.join(sourceRoot, 'entry-server.tsx'),
+    components: path.join(sourceRoot, 'components/docs/index.ts'),
     search: path.join(sourceRoot, 'lib/search/provider.ts'),
   },
   external: isExternal,

package/scripts/check-package.mjs

@@ -7,6 +7,7 @@ for (const relativeFile of [
   'bin/shiso.mjs',
   'dist/entry-client.js',
   'dist/entry-server.js',
+  'dist/components.js',
   'dist/search.js',
   'docs.schema.json',
   'scripts/lib/mdast.mjs',
@@ -14,6 +15,7 @@ for (const relativeFile of [
   'scripts/lib/slug.mjs',
   'src/styles/global.css',
   'types/client.d.ts',
+  'types/components.d.ts',
   'types/search.d.ts',
   'vite.config.ts',
 ]) {

package/scripts/generate-last-modified.mjs

@@ -18,7 +18,7 @@ import { promisify } from 'node:util';
 const execFileAsync = promisify(execFile);
 
 const DEFAULT_ROOT = process.cwd();
-const CONTENT_EXTENSIONS = new Set(['.md', '.mdx']);
+const CONTENT_EXTENSIONS = new Set(['.md', '.mdx', '.tsx']);
 
 async function collectContentFiles(dir, files = []) {
   let entries;
@@ -115,7 +115,7 @@ export function shisoLastModified(options = {}) {
       await generateLastModified(options);
     },
     async handleHotUpdate({ file }) {
-      if (/\.(md|mdx)$/.test(file)) {
+      if (/\.(md|mdx|tsx)$/.test(file)) {
         await generateLastModified(options);
       }
     },

package/src/components/Header.tsx

@@ -6,7 +6,12 @@ import { ThemeToggle } from '@/components/ThemeToggle';
 import { TopNav } from '@/components/TopNav';
 import { VersionSwitcher } from '@/components/VersionSwitcher';
 import { isExternalHref } from '@/lib/paths';
-import { docsHomeUrl, getScopeByPathname, hasRootStandalonePage } from '@/lib/site-config';
+import {
+  docsHomeUrl,
+  getPageFrontmatter,
+  getScopeByPathname,
+  hasRootStandalonePage,
+} from '@/lib/site-config';
 import type { NormalizedLink, SiteModel } from '@/lib/types';
 
 /**
@@ -62,6 +67,7 @@ export function Header({ site }: { site: SiteModel }) {
   const { pathname } = useLocation();
   // The header renders the navigation of whichever scope owns the current page.
   const docs = getScopeByPathname(pathname).docs;
+  const showSearch = getPageFrontmatter(pathname)?.search !== false;
   // The brand links to the standalone home page when one owns "/".
   const brandHref = logo?.href || (hasRootStandalonePage ? '/' : docsHomeUrl);
   const hasBrand = !!name || !!logo?.light || !!logo?.dark;
@@ -114,7 +120,7 @@ export function Header({ site }: { site: SiteModel }) {
           {docs.showTabs ? <TopNav docs={docs} label={labels.sections} /> : null}
         </div>
         <div className="flex min-w-0 items-center gap-2 justify-self-end">
-          <Search config={search} labels={labels} />
+          {showSearch ? <Search config={search} labels={labels} /> : null}
           {navbar?.links.map(link => (
             <NavbarLinkItem key={link.href} link={link} />
           ))}

package/src/entry-server.tsx

@@ -36,15 +36,18 @@ export function getRoutes(): string[] {
 export { getRedirects };
 
 /**
- * Source file for every routed page, so the prerenderer can publish raw
+ * Source file for every Markdown/MDX page, so the prerenderer can publish raw
  * markdown next to each HTML page (used by the contextual menu's copy/view
- * options and by AI tools). `filePath` is a module key like
- * "/content/docs/index.mdx", resolved against the project root.
+ * options and by AI tools). TSX standalone pages have no raw Markdown copy.
+ * `filePath` is a module key like "/content/docs/index.mdx", resolved against
+ * the project root.
  */
 export function getMarkdownPages(): { route: string; filePath: string }[] {
   return [
     ...docsSite.pages.map(page => ({ route: page.url, filePath: page.filePath })),
-    ...standalonePages.map(page => ({ route: page.path, filePath: page.filePath })),
+    ...standalonePages
+      .filter(page => !page.filePath.endsWith('.tsx'))
+      .map(page => ({ route: page.path, filePath: page.filePath })),
   ];
 }
 

package/src/lib/content.ts

@@ -3,10 +3,9 @@ import { CONTENT_DIR, PAGES_DIR } from '@/lib/paths';
 import type { DocModule } from '@/lib/types';
 
 /**
- * Eagerly imports every content file at build time. Each module exports:
- * - default: the compiled MDX component
- * - frontmatter: parsed YAML frontmatter
- * - toc: heading anchors injected by the remark-toc plugin
+ * Eagerly imports every content file at build time. Markdown/MDX modules
+ * export a compiled component plus generated frontmatter and TOC values. TSX
+ * standalone pages export their component and may export frontmatter directly.
  *
  * Eager loading keeps server prerendering and client hydration in sync
  * without Suspense, at the cost of bundling all pages together.
@@ -16,7 +15,7 @@ import type { DocModule } from '@/lib/types';
  * lookup time instead. That also lets later versioned/localized content roots
  * (`content/v2`, `content/es`) work without touching this glob.
  */
-export const docModules = import.meta.glob('/content/**/*.{md,mdx}', {
+export const docModules = import.meta.glob('/content/**/*.{md,mdx,tsx}', {
   eager: true,
 }) as Record<string, DocModule>;
 
@@ -35,7 +34,12 @@ export function resolveDocFile(fileSlug: string, contentDir = CONTENT_DIR): stri
  * under the fixed content/pages root.
  */
 export function resolvePageFile(fileSlug: string): string | undefined {
-  return resolveDocFile(fileSlug, PAGES_DIR);
+  const candidates = [
+    `/${PAGES_DIR}/${fileSlug}.tsx`,
+    `/${PAGES_DIR}/${fileSlug}.mdx`,
+    `/${PAGES_DIR}/${fileSlug}.md`,
+  ];
+  return candidates.find(candidate => candidate in docModules);
 }
 
 export function getDocModule(filePath: string): DocModule | undefined {

package/src/lib/site-config.ts

@@ -1,6 +1,6 @@
 import shisoConfig from 'virtual:shiso-config';
 import rawConfig from 'virtual:shiso-docs-config';
-import { resolveDocFile, resolvePageFile } from '@/lib/content';
+import { getDocModule, resolveDocFile, resolvePageFile } from '@/lib/content';
 import {
   assertDocsConfig,
   getDefaultScope,
@@ -126,6 +126,12 @@ export function getPageByPathname(pathname: string): NormalizedDocsPage | null {
   return getSitePageByPathname(docsSite, stripBase(pathname));
 }
 
+/** Frontmatter for the docs or standalone page that owns a pathname. */
+export function getPageFrontmatter(pathname: string) {
+  const page = getStandalonePage(pathname) || getPageByPathname(pathname);
+  return page ? getDocModule(page.filePath)?.frontmatter : undefined;
+}
+
 export function getPageTitle(pageTitle?: string): string {
   if (pageTitle && siteName) {
     return `${pageTitle} – ${siteName}`;

package/src/lib/standalone-pages.ts

@@ -28,7 +28,7 @@ function normalizePath(rawPath: unknown): string {
     throw invalid(`standalone page path "${value}" must not use wildcard patterns.`);
   }
 
-  if (/\.mdx?$/i.test(value)) {
+  if (/\.(?:mdx?|tsx)$/i.test(value)) {
     throw invalid(
       `standalone page path "${value}" must be a route, not a file — drop the extension.`,
     );
@@ -48,7 +48,7 @@ function normalizePageSlug(rawSlug: unknown): string {
       .replace(/\\/g, '/')
       .replace(/^\/+/, '')
       .replace(/^pages\//, '')
-      .replace(/\.mdx?$/, '')
+      .replace(/\.(?:mdx?|tsx)$/, '')
       .replace(/\/+$/, '') || 'index'
   );
 }
@@ -104,7 +104,7 @@ export function normalizeStandalonePages(
     if (!filePath) {
       throw new Error(
         `Missing standalone page file for "${fileSlug}": expected ` +
-          `"content/pages/${fileSlug}.mdx" or ".md".`,
+          `"content/pages/${fileSlug}.tsx", ".mdx", or ".md".`,
       );
     }
 

package/src/lib/types.ts

@@ -189,7 +189,7 @@ export interface RedirectRule {
 export interface StandalonePageItem {
   /** Route path, starting with "/". "/" replaces the root redirect to docs. */
   path: string;
-  /** File slug under content/pages, e.g. "home" for content/pages/home.mdx. */
+  /** File slug under content/pages, e.g. "home" for content/pages/home.tsx. */
   page: string;
   /** Page title used in the document head. Frontmatter title wins. */
   title?: string;
@@ -199,7 +199,7 @@ export interface StandalonePageItem {
 export interface StandalonePage {
   /** Base-relative route, e.g. "/" or "/about". */
   path: string;
-  /** Module key of the MDX file, e.g. "/content/pages/home.mdx". */
+  /** Module key of the TSX, MDX, or Markdown file. */
   filePath: string;
   /** Config-level head-title override. */
   title?: string;
@@ -555,6 +555,8 @@ export interface DocFrontmatter {
   title?: string;
   description?: string;
   noindex?: boolean;
+  /** Hide the header search control and disable its shortcut on this page. */
+  search?: false;
   /** Overrides the site-wide `metadata.timestamp` setting for this page. */
   timestamp?: boolean;
   /** Related pages rendered above the prev/next pager. */

package/src/pages/StandalonePage.tsx

@@ -7,8 +7,8 @@ import type { SiteModel, StandalonePage } from '@/lib/types';
 
 /**
  * A standalone (non-docs) page: site chrome from Layout (banner, header),
- * the MDX content at full container width — no sidebar, TOC, or pager — and
- * the footer. MDX components come from the app-level MDXProvider.
+ * content at full container width — no sidebar, TOC, or pager — and the
+ * footer. Markdown/MDX gets docs typography; TSX owns its presentation.
  */
 export function StandalonePageView({ page, site }: { page: StandalonePage; site: SiteModel }) {
   const { pathname } = useLocation();
@@ -28,14 +28,21 @@ export function StandalonePageView({ page, site }: { page: StandalonePage; site:
   }
 
   const Content = doc.default;
+  const isComponentPage = page.filePath.endsWith('.tsx');
 
   return (
     <div className="flex min-h-full flex-col">
-      <article className="grow py-8">
-        <div className="docs-markdown">
+      {isComponentPage ? (
+        <div className="grow">
           <Content />
         </div>
-      </article>
+      ) : (
+        <article className="grow py-8">
+          <div className="docs-markdown">
+            <Content />
+          </div>
+        </article>
+      )}
       <Footer footer={site.footer} />
     </div>
   );

package/src/styles/global.css

@@ -99,11 +99,11 @@
     color: color-mix(in srgb, var(--foreground) 25%, var(--muted-foreground));
   }
 
-  .docs-markdown > * + * {
+  .docs-markdown > * + *:not(:where(.not-prose, .not-prose *)) {
     margin-top: 1rem;
   }
 
-  .docs-markdown :where(h1, h2, h3, h4, h5, h6) {
+  .docs-markdown :where(h1, h2, h3, h4, h5, h6):not(:where(.not-prose, .not-prose *)) {
     font-family: var(--font-heading);
     font-weight: var(--font-heading-weight, 600);
     letter-spacing: -0.02em;
@@ -128,57 +128,57 @@
     opacity: 1;
   }
 
-  .docs-markdown h2 {
+  .docs-markdown h2:not(:where(.not-prose, .not-prose *)) {
     margin-top: 2.25rem;
     margin-bottom: 1rem;
     font-size: 1.5rem;
   }
 
-  .docs-markdown h3 {
+  .docs-markdown h3:not(:where(.not-prose, .not-prose *)) {
     margin-top: 1.75rem;
     margin-bottom: 0.75rem;
     font-size: 1.2rem;
   }
 
-  .docs-markdown p {
+  .docs-markdown p:not(:where(.not-prose, .not-prose *)) {
     margin: 0.75rem 0;
   }
 
-  .docs-markdown ul,
-  .docs-markdown ol {
+  .docs-markdown ul:not(:where(.not-prose, .not-prose *)),
+  .docs-markdown ol:not(:where(.not-prose, .not-prose *)) {
     margin: 0.75rem 0;
     padding-left: 1.25rem;
   }
 
-  .docs-markdown ul {
+  .docs-markdown ul:not(:where(.not-prose, .not-prose *)) {
     list-style: disc;
   }
 
-  .docs-markdown ol {
+  .docs-markdown ol:not(:where(.not-prose, .not-prose *)) {
     list-style: decimal;
   }
 
-  .docs-markdown li {
+  .docs-markdown li:not(:where(.not-prose, .not-prose *)) {
     margin: 0.35rem 0;
   }
 
-  .docs-markdown :where(strong, b) {
+  .docs-markdown :where(strong, b):not(:where(.not-prose, .not-prose *)) {
     color: var(--foreground);
     font-weight: 600;
   }
 
-  .docs-markdown a {
+  .docs-markdown a:not(:where(.not-prose, .not-prose *)) {
     color: var(--foreground);
     text-decoration: underline;
     text-decoration-color: color-mix(in srgb, currentColor 30%, transparent);
     text-underline-offset: 0.2em;
   }
 
-  .docs-markdown a:hover {
+  .docs-markdown a:hover:not(:where(.not-prose, .not-prose *)) {
     text-decoration-color: currentColor;
   }
 
-  .docs-markdown code:not(pre code) {
+  .docs-markdown code:not(pre code):not(:where(.not-prose, .not-prose *)) {
     color: var(--foreground);
     border-radius: var(--radius-sm);
     background: color-mix(in srgb, currentColor 4%, transparent);
@@ -188,7 +188,7 @@
 
   /* Styled to match the PropertiesTable component: rounded outer border,
      horizontal row separators only, and no header fill. */
-  .docs-markdown table {
+  .docs-markdown table:not(:where(.not-prose, .not-prose *)) {
     width: 100%;
     margin: 1rem 0;
     font-size: 0.875rem;
@@ -198,12 +198,12 @@
     border-radius: var(--radius-lg);
   }
 
-  .docs-markdown th {
+  .docs-markdown th:not(:where(.not-prose, .not-prose *)) {
     color: var(--foreground);
   }
 
-  .docs-markdown th,
-  .docs-markdown td {
+  .docs-markdown th:not(:where(.not-prose, .not-prose *)),
+  .docs-markdown td:not(:where(.not-prose, .not-prose *)) {
     border: none;
     border-bottom: 1px solid var(--border);
     padding: 0.6rem 0.75rem;
@@ -211,36 +211,36 @@
     vertical-align: top;
   }
 
-  .docs-markdown th:first-child,
-  .docs-markdown td:first-child {
+  .docs-markdown th:first-child:not(:where(.not-prose, .not-prose *)),
+  .docs-markdown td:first-child:not(:where(.not-prose, .not-prose *)) {
     padding-left: 1.5rem;
   }
 
-  .docs-markdown th:last-child,
-  .docs-markdown td:last-child {
+  .docs-markdown th:last-child:not(:where(.not-prose, .not-prose *)),
+  .docs-markdown td:last-child:not(:where(.not-prose, .not-prose *)) {
     padding-right: 1.5rem;
   }
 
-  .docs-markdown th {
+  .docs-markdown th:not(:where(.not-prose, .not-prose *)) {
     background: transparent;
     font-weight: 600;
   }
 
-  .docs-markdown tbody tr:last-child td {
+  .docs-markdown tbody tr:last-child td:not(:where(.not-prose, .not-prose *)) {
     border-bottom: none;
   }
 
-  .docs-markdown table code:not(pre code) {
+  .docs-markdown table code:not(pre code):not(:where(.not-prose, .not-prose *)) {
     font-size: 0.75rem;
   }
 
-  .docs-markdown blockquote {
+  .docs-markdown blockquote:not(:where(.not-prose, .not-prose *)) {
     border-left: 3px solid var(--input);
     padding-left: 1rem;
     color: var(--muted-foreground);
   }
 
-  .docs-markdown hr {
+  .docs-markdown hr:not(:where(.not-prose, .not-prose *)) {
     border: none;
     border-top: 1px solid var(--border);
     margin: 2rem 0;