@usecross/docs 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,178 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { C as CodeBlockProps, D as DocsLayoutProps, a as DocContent, M as MarkdownProps, S as SidebarProps, b as DocsAppConfig } from './types-Vodb50Bj.js';
+export { N as NavItem, c as NavSection, d as SharedProps } from './types-Vodb50Bj.js';
+import { ReactNode } from 'react';
+import { ClassValue } from 'clsx';
+import { HighlighterCore } from 'shiki/core';
+
+/**
+ * Syntax-highlighted code block component using Shiki.
+ */
+declare function CodeBlock({ code, language, filename, showLineNumbers, theme, className, }: CodeBlockProps): react_jsx_runtime.JSX.Element;
+/**
+ * Simple inline code component.
+ */
+declare function InlineCode({ children }: {
+    children: React.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+/**
+ * Full-featured documentation layout with sidebar, mobile menu, and header.
+ */
+declare function DocsLayout({ children, title, description: _description, logo, logoInverted, logoUrl: propLogoUrl, logoInvertedUrl: propLogoInvertedUrl, githubUrl: propGithubUrl, navLinks: propNavLinks, footer, }: DocsLayoutProps): react_jsx_runtime.JSX.Element;
+
+interface DocsPageProps extends Omit<DocsLayoutProps, 'children' | 'title'> {
+    content: DocContent;
+}
+/**
+ * Default documentation page component.
+ * Renders markdown content within the DocsLayout.
+ */
+declare function DocsPage({ content, ...layoutProps }: DocsPageProps): react_jsx_runtime.JSX.Element;
+
+interface HomeFeature {
+    title: string;
+    description: ReactNode;
+}
+interface HomePageContextValue {
+    title: string;
+    tagline: string;
+    description: string;
+    installCommand: string;
+    ctaText: string;
+    ctaHref: string;
+    features: HomeFeature[];
+    logoUrl?: string;
+    heroLogoUrl?: string;
+    footerLogoUrl?: string;
+    githubUrl?: string;
+    navLinks: Array<{
+        label: string;
+        href: string;
+    }>;
+}
+interface HomePageProps extends Omit<HomePageContextValue, 'navLinks'> {
+    navLinks?: Array<{
+        label: string;
+        href: string;
+    }>;
+    children?: ReactNode;
+}
+interface HomeHeaderProps {
+    renderLogo?: () => ReactNode;
+}
+interface HomeFeaturesProps {
+    renderFeature?: (feature: HomeFeature, index: number, DefaultFeature: typeof HomeFeatureItem) => ReactNode;
+}
+interface HomeFeatureItemProps {
+    feature: HomeFeature;
+    index: number;
+    totalFeatures: number;
+}
+/**
+ * Navigation header for the homepage.
+ * Accepts an optional renderLogo prop for custom logo rendering.
+ */
+declare function HomeHeader({ renderLogo }?: HomeHeaderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hero section with title, tagline, description, and CTA.
+ * If heroLogoUrl is provided, displays an image instead of text title.
+ */
+declare function HomeHero(): react_jsx_runtime.JSX.Element;
+/**
+ * Single feature item within the features grid.
+ */
+declare function HomeFeatureItem({ feature, index, totalFeatures }: HomeFeatureItemProps): react_jsx_runtime.JSX.Element;
+/**
+ * Features section with customizable feature rendering.
+ */
+declare function HomeFeatures({ renderFeature }?: HomeFeaturesProps): react_jsx_runtime.JSX.Element | null;
+/**
+ * Call-to-action section.
+ */
+declare function HomeCTA(): react_jsx_runtime.JSX.Element;
+/**
+ * Footer section.
+ */
+declare function HomeFooter(): react_jsx_runtime.JSX.Element;
+/**
+ * Homepage component for documentation sites.
+ *
+ * Can be used in two ways:
+ *
+ * 1. Simple - everything from config:
+ * ```tsx
+ * <HomePage {...props} />
+ * ```
+ *
+ * 2. Composable - full control via children:
+ * ```tsx
+ * <HomePage {...props}>
+ *   <HomePage.Header />
+ *   <HomePage.Hero />
+ *   <MyCustomSection />
+ *   <HomePage.Features renderFeature={(feature, i, Default) => (
+ *     <Default feature={feature} index={i} totalFeatures={4} />
+ *   )} />
+ *   <HomePage.CTA />
+ *   <HomePage.Footer />
+ * </HomePage>
+ * ```
+ */
+declare function HomePage({ children, navLinks, ...props }: HomePageProps): react_jsx_runtime.JSX.Element;
+declare namespace HomePage {
+    var Header: typeof HomeHeader;
+    var Hero: typeof HomeHero;
+    var Features: typeof HomeFeatures;
+    var Feature: typeof HomeFeatureItem;
+    var CTA: typeof HomeCTA;
+    var Footer: typeof HomeFooter;
+}
+
+/**
+ * Markdown renderer with syntax highlighting and GFM support.
+ */
+declare function Markdown({ content, components }: MarkdownProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Documentation sidebar with section-based navigation.
+ */
+declare function Sidebar({ nav, currentPath, className }: SidebarProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Create and mount an Inertia.js documentation app.
+ *
+ * @example
+ * ```tsx
+ * import { createDocsApp, DocsPage } from '@usecross/docs'
+ *
+ * createDocsApp({
+ *   pages: {
+ *     'docs/DocsPage': DocsPage,
+ *   },
+ *   title: (title) => `${title} - My Docs`,
+ * })
+ * ```
+ */
+declare function createDocsApp(config: DocsAppConfig): void;
+
+/**
+ * Merge Tailwind CSS classes with clsx
+ */
+declare function cn(...inputs: ClassValue[]): string;
+
+/**
+ * Get or create a Shiki highlighter instance.
+ * Uses a singleton pattern to avoid creating multiple highlighters.
+ */
+declare function getHighlighter(): Promise<HighlighterCore>;
+/**
+ * Configure the highlighter with custom themes and languages.
+ * Must be called before getHighlighter() is first called.
+ */
+declare function configureHighlighter(options: {
+    theme?: Promise<any>;
+    langs?: Promise<any>[];
+}): void;
+
+export { CodeBlock, CodeBlockProps, DocContent, DocsAppConfig, DocsLayout, DocsLayoutProps, DocsPage, HomeCTA, type HomeFeature, HomeFeatureItem, type HomeFeatureItemProps, HomeFeatures, type HomeFeaturesProps, HomeFooter, HomeHeader, type HomeHeaderProps, HomeHero, HomePage, type HomePageContextValue, type HomePageProps, InlineCode, Markdown, MarkdownProps, Sidebar, SidebarProps, cn, configureHighlighter, createDocsApp, getHighlighter };