UNPKG

aglio-theme-goose

Version:

Custom theme for the Aglio API Blueprint renderer

github.com/cuiweiqiang/aglio-theme-goose

cuiweiqiang/aglio-theme-goose

55 lines (38 loc) • 3.36 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Aglio Default Theme [![Dependency Status](https://img.shields.io/david/danielgtaylor/aglio/olio-theme.svg)](https://david-dm.org/danielgtaylor/aglio) [![Build Status](http://img.shields.io/travis/danielgtaylor/aglio/olio-theme.svg)](https://travis-ci.org/danielgtaylor/aglio) [![Coverage Status](http://img.shields.io/coveralls/danielgtaylor/aglio/olio-theme.svg)](https://coveralls.io/r/danielgtaylor/aglio) [![NPM version](http://img.shields.io/npm/v/aglio-theme-olio.svg)](https://www.npmjs.org/package/aglio-theme-olio) [![License](http://img.shields.io/npm/l/aglio-theme-olio.svg)](https://www.npmjs.org/package/aglio-theme-olio) This is *Olio*, the default theme engine for [Aglio](https://github.com/danielgtaylor/aglio). It takes an [API Blueprint](http://apiblueprint.org/) AST and renders it into static HTML. Example use: ```bash $ sudo npm install -g aglio $ aglio -i blueprint.apib -o MyAPI.html ``` Theme engines for Aglio are described in more detail in the [Aglio documentation](https://github.com/danielgtaylor/aglio#customizing-output). ## 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: * [Less](http://lesscss.org/) to produce CSS * [Markdown-it](https://github.com/markdown-it/markdown-it#readme) to render Markdown * [Jade](http://jade-lang.com/) to produce HTML * [Highlight.js](https://highlightjs.org/) to highlight code snippets 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 © 2016 Daniel G. Taylor http://dgt.mit-license.org/