danielgtaylor/aglio
Aglio
Aglio est un outil en ligne de commande et un moteur de rendu HTML statique conçu pour convertir les fichiers de spécification API Blueprint en documentation web lisible. Il transforme des spécifications d'API structurées en pages HTML autonomes qui peuvent être hébergées et distribuées sans serveur backend.
Le projet inclut un moteur de thèmes qui permet la personnalisation des styles visuels via des variables CSS et des surcharges de modèles de mise en page. Les utilisateurs peuvent appliquer des thèmes intégrés ou intégrer des modules externes pour modifier la façon dont la documentation est rendue.
L'outil prend en charge la composition de documents modulaires, permettant la fusion de plusieurs fichiers de spécification et Markdown en un seul document via des inclusions de chemins relatifs. Il fournit également un serveur de développement local avec un aperçu en temps réel pour visualiser les changements rendus.
Features
- Static HTML Generators - Converts structured API specifications into standalone, non-interactive HTML files for static hosting.
- AST to HTML Renderers - Transforms the parsed API specification abstract syntax tree into structured static HTML output.
- Modular Document Composition - Merges multiple specification and markdown files into a single document through a recursive include mechanism.
- Partial Document Inclusion - Embeds separate specification and markdown files into a single document using relative path partials.
- API Specification Managers - Organizes large API definition files by merging multiple specifications into a single rendered document.
- API Blueprint Rendering - Converts API Blueprint specification files into static HTML pages to create a readable website for developers.
- API Documentation - Provides technical specifications and visual styling for API documentation using themes and CSS.
- API Documentation Generators - Automatically generates static HTML documentation for API endpoints from specification files.
- Documentation Themes - Implements a system of pre-built visual templates and layouts designed specifically for API documentation.
- HTML Document Renderers - Transforms API Blueprint specification formats into structured HTML for web-based display.
- Document Inclusion Tracking - Extracts all linked files within a document to trigger automatic build updates and file watching.
- Document Parsing CLI Tools - Provides a command-line interface for triggering the conversion of API specifications into HTML.
- Documentation Previewers - Renders API documentation files in real-time within a browser during the editing process.
- Live Preview Servers - Provides a local server that renders documents and refreshes the browser automatically as source files change.
- Source File Watching - Monitors source files and their relative inclusions to trigger automatic rebuilds during development.
- CSS Variable Theming - Maps configuration variables to native CSS variables to control the visual theme of the documentation.
- Theme Style Customizations - Allows overriding default design tokens for colors, fonts, and spacing via configuration to style the output.
- Visual Style Customization - Provides mechanisms to apply custom CSS and layout variables to modify the overall appearance of the generated documentation.
- Template Overrides - Allows replacing default HTML layout files with custom templates to change the overall structure of the documentation.
- Custom Themes - Supports the application of built-in or custom visual themes specifically designed for API documentation interfaces.
- Layout Wrappers - Injects rendered documentation content into customizable HTML wrappers to control page structure.
- API Design Tools - Renders API Blueprint files into static HTML documentation.
- API Documentation - Renders API Blueprint documentation to HTML.
- Miscellaneous Tools - Renderer for API documentation.
