Generate a static HTML reference page for a REST API from a Markdown Blueprint description
Preview API documentation live in a browser as you write the Blueprint file
Host generated API docs on any static web server without a backend or special setup
Call aglio from a Node.js build script to generate HTML docs as part of an automated pipeline
| danielgtaylor/aglio | jariz/vibrant.js | yakyak/yakyak | |
|---|---|---|---|
| Stars | 4,756 | 4,597 | 3,762 |
| Language | CoffeeScript | CoffeeScript | CoffeeScript |
| Setup difficulty | easy | easy | easy |
| Complexity | 2/5 | 2/5 | 2/5 |
| Audience | developer | developer | general |
Figures from each repo's GitHub metadata at analysis time.
Aglio is a tool that converts API Blueprint files into static HTML documentation pages. API Blueprint is a Markdown-based format for writing descriptions of HTTP APIs: you write plain text files that describe your endpoints, the parameters they accept, and example request and response bodies, then use a tool like Aglio to turn those files into readable, styled documentation you can share with developers or host on any web server. The generated HTML works on any standard web host without special setup. Aglio supports several built-in visual themes, including options named streak, flatly, slate, and cyborg, and can produce either a two-column or three-column page layout. You can also supply your own custom templates if none of the defaults suit your needs. The tool has three modes of use. As a command-line program, you point it at an input Blueprint file and it writes an HTML file. You can also run it in server mode, which watches the input file for changes and serves a live-reloading preview in a browser as you write. The third option is calling it as a Node.js library, which lets you invoke the HTML rendering step from your own code and pass custom options or template variables. Aglio supports splitting large API descriptions across multiple files using an include directive, so you can organize a complex API into smaller, manageable sections that are stitched together at render time. The README notes that the project is mature and stable but is no longer actively maintained by the original author. The project is released under the MIT license.
A command-line tool that converts API Blueprint Markdown files into styled, shareable HTML documentation pages, with live browser preview, multiple built-in themes, and a Node.js library mode.
Mainly CoffeeScript. The stack also includes Node.js, CoffeeScript.
Use freely for any purpose, including commercial use, as long as you include the MIT license notice.
Setup difficulty is rated easy, with roughly 5min to a first successful run.
Mainly developer.
This repo across BitVibe Labs
Verify against the repo before relying on details.