@stacksjs/stx/dist/docs.d.ts

A performant UI Framework. Powered by Bun.

import { config } from './config';
import type { ComponentDoc, ComponentPropDoc, DirectiveDoc, DocGeneratorConfig, TemplateDoc } from './types';
/**
 * Extract component properties from a component file
 */
export declare function extractComponentProps(componentPath: string): Promise<ComponentPropDoc[]>;
/**
 * Extract component description from a component file
 */
export declare function extractComponentDescription(componentPath: string): Promise<string>;
/**
 * Generate documentation for a component
 */
export declare function generateComponentDoc(componentPath: string, isWebComponent?: any, webComponentTag?: string): Promise<ComponentDoc>;
/**
 * Find all component files in a directory
 */
export declare function findComponentFiles(componentsDir: string): Promise<string[]>;
/**
 * Generate documentation for all components
 */
export declare function generateComponentsDocs(componentsDir: string, webComponentsConfig?: any): Promise<ComponentDoc[]>;
/**
 * Generate documentation for templates
 */
export declare function generateTemplatesDocs(templatesDir: string): Promise<TemplateDoc[]>;
/**
 * Generate documentation for directives
 */
export declare function generateDirectivesDocs(customDirectives?: any[]): Promise<DirectiveDoc[]>;
/**
 * Format documentation as Markdown
 */
export declare function formatDocsAsMarkdown(componentDocs?: ComponentDoc[], templateDocs?: TemplateDoc[], directiveDocs?: DirectiveDoc[], extraContent?: string): string;
/**
 * Format documentation as HTML
 */
export declare function formatDocsAsHtml(componentDocs?: ComponentDoc[], templateDocs?: TemplateDoc[], directiveDocs?: DirectiveDoc[], extraContent?: string): string;
/**
 * Format documentation as JSON
 */
export declare function formatDocsAsJson(componentDocs?: ComponentDoc[], templateDocs?: TemplateDoc[], directiveDocs?: DirectiveDoc[], extraContent?: string): string;
/**
 * Generate documentation
 */
export declare function generateDocs(options: {
  componentsDir?: string
  templatesDir?: string
  webComponentsConfig?: any
  customDirectives?: any[]
  config: Partial<DocGeneratorConfig>
}): Promise<boolean>;
/**
 * Documentation generation command handler for CLI
 */
export declare function docsCommand(options: any): Promise<boolean>;