Skip to content

Commit

Permalink
Generate new and updated examples
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgtaylor committed Oct 30, 2015
1 parent 1166312 commit 3e4fbe4
Show file tree
Hide file tree
Showing 12 changed files with 2,779 additions and 271 deletions.
6 changes: 4 additions & 2 deletions Gruntfile.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,11 @@ module.exports = (grunt) ->
console.log "Generating examples/#{name}.html"
aglio.renderFile 'example.apib', "examples/#{name}.html", themeVariables: name, (err) ->
if err then return done(err)
done()
console.log "Generating examples/#{name}-triple.html"
aglio.renderFile 'example.apib', "examples/#{name}-triple.html", themeVariables: name, themeTemplate: 'triple', (err) ->
done(err)

async.each ['default', 'flatly', 'slate', 'cyborg'], render, done
async.each ['default', 'flatly', 'slate', 'cyborg', 'streak'], render, done


grunt.registerTask 'compile', ['coffeelint', 'coffee']
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ An [API Blueprint](http://apiblueprint.org/) renderer that supports multiple the
## 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](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/default.html)
* [Flatly theme](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/flatly.html)
* [Slate theme](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/slate.html)
* [Cyborg theme](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/cyborg.html)
* 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.
Expand Down Expand Up @@ -53,10 +54,13 @@ Then, start generating HTML.
# 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 build-in style
# Customize a built-in style
aglio --theme-style default --theme-style ./my-style.less -i input.apib -o output.html

# Custom layout template
Expand Down
405 changes: 405 additions & 0 deletions examples/cyborg-triple.html

Large diffs are not rendered by default.

150 changes: 84 additions & 66 deletions examples/cyborg.html

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions examples/default-triple.html

Large diffs are not rendered by default.

150 changes: 84 additions & 66 deletions examples/default.html

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions examples/flatly-triple.html

Large diffs are not rendered by default.

150 changes: 84 additions & 66 deletions examples/flatly.html

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions examples/slate-triple.html

Large diffs are not rendered by default.

150 changes: 84 additions & 66 deletions examples/slate.html

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions examples/streak-triple.html

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions examples/streak.html

Large diffs are not rendered by default.

0 comments on commit 3e4fbe4

Please sign in to comment.