@mui/internal-docs-infra
Version:
MUI Infra - internal documentation creation tools.
23 lines • 951 B
text/typescript
import type * as React from 'react';
import type { Sitemap } from "./types.mjs";
type CreateSitemapMeta = {
name?: string;
slug?: string;
displayName?: string;
precompute?: Sitemap;
skipPrecompute?: boolean;
[key: string]: any;
};
/**
* Creates sitemap data from page components with optional precomputed data.
* Returns a sitemap data object containing schema and page data.
*
* In Next.js builds, the webpack loader precomputes the sitemap data.
* Outside Next.js (e.g., tests or scripts), use `loadServerSitemap()` for runtime loading.
*
* @param sourceUrl Depends on `import.meta.url` to determine the source file location.
* @param pages Record of page components indexed by path.
* @param meta Additional meta and precomputed sitemap configuration.
*/
export declare function createSitemap(sourceUrl: string, pages: Record<string, React.ComponentType<any> | null>, meta?: CreateSitemapMeta): Sitemap | undefined;
export {};