Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielgtaylor/aglio
An API Blueprint renderer with theme support that outputs static HTML
https://github.com/danielgtaylor/aglio
Last synced: about 1 month ago
JSON representation
An API Blueprint renderer with theme support that outputs static HTML
- Host: GitHub
- URL: https://github.com/danielgtaylor/aglio
- Owner: danielgtaylor
- Created: 2013-11-15T03:24:36.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-05-13T14:40:13.000Z (over 5 years ago)
- Last Synced: 2024-04-14T13:11:28.696Z (7 months ago)
- Language: CoffeeScript
- Size: 779 KB
- Stars: 4,740
- Watchers: 114
- Forks: 481
- Open Issues: 136
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
Awesome Lists containing this project
- awesome-ruby-api - Aglio - An API Blueprint renderer. (Documentation)
README
[](https://david-dm.org/danielgtaylor/aglio) [](https://travis-ci.org/danielgtaylor/aglio) [](https://coveralls.io/r/danielgtaylor/aglio) [](https://www.npmjs.org/package/aglio) [](https://www.npmjs.org/package/aglio) [](https://gitter.im/danielgtaylor/aglio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
# Introduction
An [API Blueprint](http://apiblueprint.org/) 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](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md).
**Note**: This project is mature and stable, but I don't have much time for it anymore. If you would like to join as a maintainer then please reach out to my GitHub username at Gmail. Thanks!
## Features
* Fast parsing thanks to [Protagonist](https://github.com/apiaryio/protagonist)
* Asyncronous processing
* Multiple templates/themes
* Support for custom colors, templates, and theme engines
* Include other documents in your blueprint
* Commandline executable `aglio -i service.apib -o api.html`
* Live-reloading preview server `aglio -i service.apib --server`
* Node.js library `require('aglio')`
* Excellent test coverage
* Tested on [BrowserStack](https://www.browserstack.com/)
## Example Output
Example output is generated from the [example API Blueprint](https://raw.github.com/danielgtaylor/aglio/master/example.apib) using the default [Olio theme](https://github.com/danielgtaylor/aglio/tree/olio-theme#readme).
* Default theme [two column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/default.html) or [three column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/default-triple.html)
* Streak theme [two column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/streak.html) or [three column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/streak-triple.html)
* Flatly theme [two column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/flatly.html) or [three column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/flatly-triple.html)
* Slate theme [two column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/slate.html) or [three column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/slate-triple.html)
* Cyborg theme [two column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/cyborg.html) or [three column](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/cyborg-triple.html)
## Including Files
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.
```markdown
```
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](https://github.com/apiaryio/api-blueprint/issues/20) while allowing `aglio` users to include documents today.
# Installation & Usage
There are three ways to use aglio: as an executable, in a docker container or as a library for Node.js.
## Executable
Install aglio via NPM. You need Node.js installed and you may need to use `sudo` to install globally:
```bash
npm install -g aglio
```
Then, start generating HTML.
```bash
# Default theme
aglio -i input.apib -o output.html
# Use three-column layout
aglio -i input.apib --theme-template triple -o output.html
# Built-in color scheme
aglio --theme-variables slate -i input.apib -o output.html
# Customize a built-in style
aglio --theme-style default --theme-style ./my-style.less -i input.apib -o output.html
# Custom layout template
aglio --theme-template /path/to/template.jade -i input.apib -o output.html
# Custom theme engine
aglio -t my-engine -i input.apib -o output.html
# Run a live preview server on http://localhost:3000/
aglio -i input.apib -s
# Print output to terminal (useful for piping)
aglio -i input.apib -o -
# Disable condensing navigation links
aglio --no-theme-condense -i input.apib -o output.html
# Render full-width page instead of fixed max width
aglio --theme-full-width -i input.apib -o output.html
# Set an explicit file include path and read from stdin
aglio --include-path /path/to/includes -i - -o output.html
# Output verbose error information with stack traces
aglio -i input.apib -o output.html --verbose
```
## With Docker
You can choose to use the provided `Dockerfile` to build yourself a repeatable and testable environment:
1. Build the image with `docker build -t aglio .`
2. Run aglio inside a container with `docker run -t aglio`
You can use the `-v` switch to dynamically mount the folder that holds your API blueprint:
```bash
docker run -v $(pwd):/tmp -t aglio -i /tmp/input.apib -o /tmp/output.html
```
## Node.js Library
You can also use aglio as a library. First, install and save it as a dependency:
```bash
npm install --save aglio
```
Then, convert some API Blueprint to HTML:
```javascript
var aglio = require('aglio');
// Render a blueprint with a template by name
var blueprint = '# Some API Blueprint string';
var options = {
themeVariables: 'default'
};
aglio.render(blueprint, options, function (err, html, warnings) {
if (err) return console.log(err);
if (warnings) console.log(warnings);
console.log(html);
});
// Render a blueprint with a custom template file
options = {
themeTemplate: '/path/to/my-template.jade'
};
aglio.render(blueprint, options, function (err, html, warnings) {
if (err) return console.log(err);
if (warnings) console.log(warnings);
console.log(html);
});
// Pass custom locals along to the template, for example
// the following gives templates access to lodash and async
options = {
themeTemplate: '/path/to/my-template.jade',
locals: {
_: require('lodash'),
async: require('async')
}
};
aglio.render(blueprint, options, function (err, html, warnings) {
if (err) return console.log(err);
if (warnings) console.log(warnings);
console.log(html);
});
```
### Reference
The following methods are available from the `aglio` library:
#### aglio.collectPathsSync (blueprint, includePath)
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.
```javascript
var blueprint = '# GET /foo\n<-- include(example.json -->\n';
var watchPaths = aglio.collectPathsSync(blueprint, process.cwd())
```
#### aglio.render (blueprint, options, callback)
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 layout name or file path string. Available options are:
| Option | Type | Default | Description |
| ----------- | ------ | ------------- | ------------------------------------- |
| filterInput | bool | `true` | Filter `\r` and `\t` from the input |
| includePath | string | process.cwd() | Base directory for relative includes |
| locals | object | `{}` | Extra locals to pass to templates |
| theme | string | `'default'` | Theme name to load for rendering |
In addition, the [default theme](https://github.com/danielgtaylor/aglio/tree/olio-theme) provides the following options:
| Option | Type | Default | Description |
| ---------------- | ------ | --------- | -------------------------------------------- |
| themeVariables | string | `default` | Built-in color scheme or path to LESS or CSS |
| themeCondenseNav | bool | `true` | Condense single-action navigation links |
| themeFullWidth | bool | `false` | Use the full page width |
| themeTemplate | string | | Layout name or path to custom layout file |
| themeStyle | string | `default` | Built-in style name or path to LESS or CSS |
```javascript
var blueprint = '...';
var options = {
themeTemplate: 'default',
locals: {
myVariable: 125
}
};
aglio.render(blueprint, options, function (err, html, warnings) {
if (err) return console.log(err);
console.log(html);
});
```
#### aglio.renderFile (inputFile, outputFile, options, callback)
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 `aglio.render`, except that the `options.includePath` defaults to the basename of the input filename.
```javascript
aglio.renderFile('/tmp/input.apib', '/tmp/output.html', options, function (err, warnings) {
if (err) return console.log(err);
if (warnings) console.log(warnings);
});
```
# Development
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:
```bash
npm install -g grunt-cli
```
Then you can build the source and run the tests:
```bash
# Lint/compile the Coffeescript
grunt
# Run the test suite
grunt test
# Generate an HTML test coverage report
grunt coverage
# Render examples
grunt examples
```
## Customizing Output
Aglio is split into two components: a base that contains logic for loading API Blueprint, handling commandline arguments, etc and a theme engine that handles turning the API Blueprint AST into HTML. The default theme engine that ships with Aglio is called [olio](https://github.com/danielgtaylor/aglio/tree/olio-theme). Templates are written in Jade, with support for inline Coffeescript, LESS and Stylus via filters. The default stylesheets are written in LESS.
While developing customizations, you may want to disable caching using the `NOCACHE` environment variable.
```bash
NOCACHE=1 aglio -i input.apib [customization options]
```
### Custom Colors & Style
Aglio's default theme provides a way to easily override colors, fonts, padding, etc to match your company's style. This is done by providing your own LESS or CSS file(s) via the `--theme-variables` and `--theme-style` options. For example:
```bash
# Use my custom colors
aglio --theme-variables /path/to/my-colors.less -i input.apib -o output.html
```
The `my-variables.less` file might contain a custom HTTP PUT color specification:
```less
/* HTTP PUT */
@put-color: #f0ad4e;
@put-background-color: #fcf8e3;
@put-text-color: contrast(@put-background-color);
@put-border-color: darken(spin(@put-background-color, -10), 5%);
```
See the [default variables](https://github.com/danielgtaylor/aglio/blob/olio-theme/styles/variables-default.less) file for examples of which variables can be set.
The `--theme-style` option lets you override built-in styles with your own LESS or CSS definitions. It is processed **after** the variables have been defined, so the variables are available for your use. If you wish to modify a rule from an existing built-in style then you must copy the style. The order of loading roughly follows:
1. Default variables
2. Built-in **or** user-supplied variables
3. Built-in **or** user-supplied style
Note that these options can be passed more than once, in which case they will be loaded in the order they were passed. This lets you, for example, load a variable preset like `flatly` and modify one of the colors with your own LESS file. Keep in mind that when you want to modify a built-in style you must explicitly list the style, e.g. `--theme-style default --theme-style my-style.less`.
#### Built-in Colors
* `cyborg`
* `default`
* `flatly`
* `slate`
#### Built-in Styles
* `default`
### Customizing Layout Templates
The `--theme-template` option allows you to provide a custom layout template that overrides the default. This is specified in the form of a [Jade](http://jade-lang.com/) template file. See the [default template](https://github.com/danielgtaylor/aglio/blob/olio-theme/templates/index.jade) file for an example.
The locals available to templates look like the following:
| Name | Description |
| ----------- | -------------------------------------------------------- |
| api | The API Blueprint 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 (`code`, `lang`) to highlight a piece of code |
| 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) |
#### Built-in Layout Templates
* `default`
### Using Custom Themes
While Aglio ships with a default theme, you have the option of installing and using third-party theme engines. They may use any technology and are not limited to Jade and LESS. Consult the theme's documentation to see which options are available and how to use and customize the theme. Common usage between all themes:
```bash
# Install a custom theme engine globally
npm install -g aglio-theme-
# Render using a custom theme engine
aglio -t -i input.apib -o output.html
# Get a list of all options for a theme
aglio -t --help
```
### Writing a Theme Engine
Theme engines are simply Node.js modules that provide two public functions and follow a specific naming scheme (`aglio-theme-NAME`). Because they are their own npm package they can use whatever technologies the theme engine author wishes. The only hard requirement is to provide these two public functions:
#### `getConfig()`
Returns configuration information about the theme, such as the API Blueprint format that is supported and any options the theme provides.
#### `render(input, options, done)`
Render the given input API Blueprint AST with the given options. Calls `done(err, html)` when finished, either passing an error or the rendered HTML output as a string.
#### Example Theme
The following is a very simple example theme. **Note**: it only returns a very simple string instead of rending out the API Blueprint AST. Normally you would invoke a template engine and output the resulting HTML that is generated.
```javascript
// Get the theme's configuration options
exports.getConfig = function () {
return {
// This is a list of all supported API Blueprint format versions
formats: ['1A'],
// This is a list of all options your theme accepts. See
// here for more: https://github.com/bcoe/yargs#readme
// Note: These get prefixed with `theme` when you access
// them in the options object later!
options: [
{
name: 'name',
description: 'Your name',
default: 'world'
}
]
};
}
// Asyncronously render out a string
exports.render = function (input, options, done) {
// Normally you would use some template engine here.
// To keep this code really simple, we just print
// out a string and ignore the API Blueprint.
done(null, 'Hello, ' + options.themeName + '!');
};
```
Example use:
```bash
# Install the theme globally
npm install -g aglio-theme-hello
# Render some output!
aglio -t hello -i example.apib -o -
=> 'Hello, world!'
# Pass in the custom theme option!
aglio -t hello --theme-name Daniel -i example.apib -o -
=> 'Hello, Daniel!'
```
You are free to use whatever template system (Jade, EJS, Nunjucks, etc) and any supporting libraries (e.g. for CSS) you like.
License
=======
Copyright (c) 2016 Daniel G. Taylor
http://dgt.mit-license.org/