UNPKG

@stacksjs/stx

Version:

A Bun plugin that allows for using Laravel Blade-like syntax.

20 lines (19 loc) 1.59 kB
import type { ComponentDoc, DirectiveDoc, TemplateDoc } from './types'; export declare function extractComponentProps(componentPath: string): Promise<ComponentPropDoc[]>; export declare function extractComponentDescription(componentPath: string): Promise<string>; export declare function generateComponentDoc(componentPath: string, isWebComponent?: boolean, webComponentTag?: string): Promise<ComponentDoc>; export declare function findComponentFiles(componentsDir: string): Promise<string[]>; export declare function generateComponentsDocs(componentsDir: string, webComponentsConfig?: any): Promise<ComponentDoc[]>; export declare function generateTemplatesDocs(templatesDir: string): Promise<TemplateDoc[]>; export declare function generateDirectivesDocs(customDirectives?: any[]): Promise<DirectiveDoc[]>; export declare function formatDocsAsMarkdown(componentDocs?: ComponentDoc[], templateDocs?: TemplateDoc[], directiveDocs?: DirectiveDoc[], extraContent?: string): string; export declare function formatDocsAsHtml(componentDocs?: ComponentDoc[], templateDocs?: TemplateDoc[], directiveDocs?: DirectiveDoc[], extraContent?: string): string; export declare function formatDocsAsJson(componentDocs?: ComponentDoc[], templateDocs?: TemplateDoc[], directiveDocs?: DirectiveDoc[], extraContent?: string): string; export declare function generateDocs(options: { componentsDir?: string templatesDir?: string webComponentsConfig?: any customDirectives?: any[] config: Partial<DocGeneratorConfig> }): Promise<boolean>; export declare function docsCommand(options: any): Promise<boolean>;