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

Algio Theme for Tanda API Docs

Theme for Aglio in used to generate Tanda API docs.

NPM package here.

Usage

First install the npm package globally:

npm install -g aglio-theme-tanda

Then generate your API documentation using your API blueprint.

aglio -i your/api/blueprint.apib -t tanda --theme-template triple -o your/api/documentation.html

Differences from Olio

The main core of this theme is from the Olio theme.

Note: These differences are only supported and tested using the three column template.

Here are the differences:

API Overview nav list indentation

Can now use # STARTLIST and # ENDLIST to define sections to indent in the nav section on the left.

Notes:

  • All # STARTLISTs need an # ENDLIST
  • Nesting is untested

API Overview content in right hand side

Can use # LHSCONTENT, # RHSCONTENT, and # ENDCONTENT to add content to the right hand side of the API overview section.

Notes:

  • # LHSCONTENT must come first, followed by # RHSCONTENT, and finally by # ENDCONTENT.
    • If you just want left or right hand side content only, you still must include all three tags.
  • Each defined content block will be aligned.

Current Tags

  • 1.1.1                                ...           latest (4 years ago)

5 Versions

  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
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 - 2016 © taobao.org |