4 Repos
Tools specifically designed to generate technical documentation and interactive examples for interface component APIs.
Distinct from API Documentation Generators: Specifically targets UI component API specifications rather than general web API endpoints.
Explore 4 awesome GitHub repositories matching development tools & productivity · UI Component API Documentation. Refine with filters or upvote what's useful.
Storybook is an integrated environment for developing, documenting, and testing user interface components. It provides a development workshop for building components in isolation from main application logic, alongside a testing tool for simulating viewports and analyzing accessibility. The project creates a living catalog of interface elements that generates interactive examples and technical documentation for component APIs. It includes a dedicated environment for visual regression testing to verify states and behaviors across different configurations and screen dimensions. The platform cov
Offers APIs to generate technical documentation and interactive examples describing component functions and behaviors.
Compodoc ist ein TypeScript-API-Dokumentationsgenerator, Static-Site-Generator und Visualisierungstool für Projektarchitekturen. Es analysiert Quellcode und JSDoc-Kommentare, um durchsuchbare technische Referenzseiten, API-Kataloge und eigenständige HTML-Seiten zu erstellen. Das Projekt zeichnet sich durch die Analyse von Import-Statements aus, um Abhängigkeitsgraphen und Modulkarten zu erstellen, die die strukturellen Beziehungen innerhalb einer Codebasis veranschaulichen. Es bietet spezialisierte Unterstützung für die Visualisierung von Angular-Projekten, NestJS-Workflows und Stencil-Webkomponenten und kann funktionierende Live-Demos direkt in Dokumentationsseiten einbetten. Das System fungiert zudem als Analysetool für die Dokumentationsabdeckung, liefert Berichte und erzwingt Mindest-Coverage-Schwellenwerte innerhalb von CI-Pipelines, um Builds bei unzureichender Dokumentation fehlschlagen zu lassen. Weitere Funktionen umfassen Markdown-Integration, Datenexport in JSON oder Markdown sowie einen lokalen Entwicklungsserver mit Dateisystem-Monitoring für automatische Rebuilds. Nutzer können die Ausgabe über Konfigurationsdateien, benutzerdefiniertes CSS-Styling und Filter für die Sichtbarkeit von Elementen anpassen, um bestimmte Symbole oder interne Tags von der finalen Seite auszuschließen.
Generates technical documentation and interactive API references specifically for Stencil web components.
dumi is a static site generator and markdown-based documentation tool specifically designed for software component libraries. It transforms markdown files and source code into structured technical guides and API references. The project distinguishes itself by providing an interactive component playground that renders live, runnable code demos directly in the browser. It includes an automated API reference generator that parses source code to create documentation tables and property descriptions. Additionally, it supports a monorepo documentation workflow with source mapping and hot module rep
Generates structured technical documentation and interactive examples specifically tailored for UI component libraries.
This project provides a comprehensive style guide and architectural framework for building maintainable, modular, and consistent components within the Vue.js ecosystem. It establishes a set of standardized rules for organizing user interface elements into self-contained units, ensuring that logic and styles remain isolated to prevent unintended side effects. The guide distinguishes itself by focusing on strict encapsulation and clear interface design. It promotes the use of namespace-based style scoping to prevent visual leakage and enforces predictable component inputs through descriptive na
Maintains clear documentation for component attributes and configuration options to facilitate easier integration and usage.