@stacksjs/stx
Version:
A performant UI Framework. Powered by Bun.
30 lines • 1.04 kB
TypeScript
import type { AnalyzedComponent, ServerStoryFile, StoryContext } from './types';
/**
* Generate documentation for all components
*/
export declare function generateStoryDocs(ctx: StoryContext, components: AnalyzedComponent[], options?: DocsOptions): Promise<void>;
/**
* Generate documentation index
*/
export declare function generateDocsIndex(components: AnalyzedComponent[]): string;
/**
* Generate documentation for a single component
*/
export declare function generateComponentDocs(component: AnalyzedComponent, storyFile?: ServerStoryFile, options?: DocsOptions): string;
/**
* Generate JSON catalog of all components
*/
export declare function generateComponentCatalog(components: AnalyzedComponent[]): string;
/**
* Export design tokens from components
*/
export declare function exportDesignTokens(components: AnalyzedComponent[]): Record<string, any>;
/**
* Documentation options
*/
export declare interface DocsOptions {
outDir?: string
includeStories?: boolean
includeSource?: boolean
template?: string
}