aglio-theme-iobeamdocs
Theme for the Aglio API Blueprint renderer modded for iobeam
Last updated 4 years ago by solugebefola .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install aglio-theme-iobeamdocs 
SYNC missed versions from official npm registry.

Aglio iobeam Theme

Dependency Status Build Status Coverage Status NPM version License

This theme is based on Olio, the default theme engine for Aglio. It takes an API Blueprint AST and renders it into static HTML. Example use:

$ sudo npm install -g aglio
$ aglio -t iobeamdocs -i blueprint.apib -o MyAPI.html

Theme engines for Aglio are described in more detail in the Aglio documentation.

The primary changes from Olio are related to anchor tags and element ids for section headings. These mods are to enable integration into a custom react wrapper for generated docs.

Design Philosophy

Olio is designed from the ground up to be both fast and extensible while maintaining backward compatibility with most of the original Aglio theme. It uses the following technologies:

For backward compatibility, Jade templates can continue to use inline Stylus and CoffeeScript.

Theme Options

Olio comes with a handful of configurable theme options. These are set via the --theme-XXX parameter, where XXX is one of the following:

Name Description
condense-nav Whether to condense nagivation for resources with only a single action (default is true).
full-width Whether to use the full page width or a responsive layout (default is responsive).
style LESS or CSS to control the layout and style of the document using the variables from below. Can be a path to your own file or one of the following presets: default. May be an array of paths and/or presets.
template Jade template to render HTML. Can be a path to your own file or one of the following presets: default.
variables LESS variables that control theme colors, fonts, and spacing. Can be a path to your own file or one of the following presets: default, flatly, slate, cyborg. May be an array of paths and/or presets.

Note: When using this theme programmatically, these options are cased like you would expect in Javascript: --theme-full-width becomes options.themeFullWidth.

Benchmark

Olio makes use of aggressive caching whenever it can, which means that rendering HTML can be blazing fast. Benchmark taken on a 2015 Macbook Pro via BENCHMARK=1 aglio -i example.apib -o example.html:

Step Cached No cache
Parse API Blueprint 44ms 44ms
Get CSS 1ms 49ms
Get template 2ms 102ms
Call template 28ms 32ms
Total time 75ms 227ms

License

Copyright © 2015 Daniel G. Taylor

http://dgt.mit-license.org/

Current Tags

  • 1.7.0                                ...           latest (4 years ago)

3 Versions

  • 1.7.0                                ...           4 years ago
  • 1.6.3                                ...           4 years ago
  • 1.6.2                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (11)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |