An API Blueprint renderer with theme support
An API Blueprint renderer that supports multiple themes and outputs static HTML that can be served by any web host. API Blueprint is a Markdown-based document format that lets you write API descriptions and documentation in a simple and straightforward way. Currently supported is API Blueprint format 1A.
aglio -i api.md -o api.html
aglio -i api.md --server
Example output is generated from the example API Blueprint.
It is possible to include other files in your blueprint by using a special include directive with a path to the included file relative to the current file's directory. Included files can be written in API Blueprint, Markdown or HTML (or JSON for response examples). Included files can include other files, so be careful of circular references.
<!-- include(filename.md) -->
For tools that do not support this include directive it will just render out as an HTML comment. API Blueprint may support its own mechanism of including files in the future, and this syntax was chosen to not interfere with the external documents proposal while allowing
aglio users to include documents today.
There are two ways to use aglio: as an executable or as a library for Node.js.
Install aglio via NPM. You need Node.js installed and you may need to use
sudo to install globally:
npm install -g aglio
Then, start generating HTML. Note that the built-in templates use scheme-relative URLs, so the resulting output files must be opened via
https:. Just opening the local file from the browser will result in a failure to load stylesheets and scripts. The
-s option described below can help you with this.
# Default templateaglio -i input.md -o output.html# Get a list of built-in templatesaglio -l# Built-in templateaglio -t slate -i input.md -o output.html# Custom templateaglio -t /path/to/template.jade -i input.md -o output.html# Run a live preview server onaglio -i input.md -s# Print output to terminal (useful for piping)aglio -i input.md -o -# Disable condensing navigation linksaglio -i input.md --no-condense -o output.html# Render full-width page instead of fixed max widthaglio -i input.md --full-width -o output.html
You can also use aglio as a library. First, install and save it as a dependency:
npm install --save aglio
Then, convert some API Blueprint to HTML:
var aglio = require'aglio';// Render a blueprint with a template by namevar blueprint = '# Some API Blueprint string';var template = 'default';agliorenderblueprint templateif err return console.logerr;if warnings console.logwarnings;console.loghtml;;// Render a blueprint with a custom template filevar customTemplate = '/path/to/my-template.jade';agliorenderblueprint customTemplateif err return console.logerr;if warnings console.logwarnings;console.loghtml;;// Pass custom locals along to the template, for example// the following gives templates access to lodash and asyncvar options =template: '/path/to/my-template.jade'locals:_: require'lodash'async: require'async';agliorenderblueprint optionsif err return console.logerr;if warnings console.logwarnings;console.loghtml;;
The following methods are available from the
Get a list of internal template names that can be used when rendering.
agliogetTemplatesif err return console.logerr;console.log'Templates: ' + namesjoin', ';;
Get a list of paths that are included in the blueprint. This list can be watched for changes to do things like live reload. The blueprint's own path is not included.
var blueprint = '# GET /foo\n<-- include(example.json -->\n';var watchPaths = agliocollectPathsSyncblueprint processcwd
Render an API Blueprint string and pass the generated HTML to the callback. The
options can either be an object of options or a simple template name or file path string. Available options are:
|condenseNav||bool||Condense navigation links|
|locals||object||Extra locals to pass to templates|
|template||string||Template name or path to custom template file|
|includePath||string||process.cwd()||Base directory for relative includes.|
var blueprint = '...';var options =template: 'default'locals:myVariable: 125;aliorenderblueprint optionsif err return console.logerr;console.loghtml;;
Render an API Blueprint file and save the HTML to another file. The input/output file arguments are file paths. The options behaves the same as above for
agliorenderFile'/tmp/input.md' '/tmp/output.html' 'default'if err return console.logerr;if warnings console.logwarnings;
Pull requests are encouraged! Feel free to fork and hack away, especially on new themes. The build system in use is Grunt, so make sure you have it installed:
npm install -g grunt-cli
Then you can build the source and run the tests:
# Lint/compile the Coffeescriptgrunt# Run the test suitegrunt test# Generate an HTML test coverage reportgrunt coverage# Render examplesgrunt examples
Themes are written using Jade, with support for Coffeescript and Stylus via filters. The output of aglio is a single HTML file, but custom themes can make use of Jade's extend and include directives, which allow you to split a theme among multiple files (the built-in themes do this). The locals available to themes look like the following:
|api||The API AST from Protagonist|
|condenseNav||If true, you should condense the nav if possible|
|date||Date and time handling from Moment.js|
|fullWidth||If true, you should consume the entire page width|
|highlight||A function (|
|markdown||A function to convert Markdown strings to HTML|
|slug||A function to convert a string to a slug usable as an ID|
|hash||A function to return an hash (currently MD5)|
The default themes in the
Copyright (c) 2014 Daniel G. Taylor