
Security News
GitHub Actions Supply Chain Attack Puts Thousands of Projects at Risk
A compromised GitHub Action exposed secrets in CI/CD logs, putting thousands of projects at risk and forcing developers to urgently secure their workflows.
aglio-theme-olio-patched
Advanced tools
This is 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 -i blueprint.apib -o MyAPI.html
Theme engines for Aglio are described in more detail in the Aglio documentation.
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.
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
.
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 |
Copyright © 2016 Daniel G. Taylor
FAQs
Default theme for the Aglio API Blueprint renderer
The npm package aglio-theme-olio-patched receives a total of 1 weekly downloads. As such, aglio-theme-olio-patched popularity was classified as not popular.
We found that aglio-theme-olio-patched demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A compromised GitHub Action exposed secrets in CI/CD logs, putting thousands of projects at risk and forcing developers to urgently secure their workflows.
Research
Security News
A malicious Maven package typosquatting a popular library is secretly stealing OAuth credentials on the 15th of each month, putting Java developers at risk.
Security News
Socket and Seal Security collaborate to fix a critical npm overrides bug, resolving a three-year security issue in the JavaScript ecosystem's most popular package manager.