Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 823 Bytes

README.md

File metadata and controls

27 lines (15 loc) · 823 Bytes
Raw

Purpose

raml-fleece turns RAML into a readable HTML file. It currently supports version 0.8 as defined in the 0.8 RAML specification

Key Features

  • Sidebar containing all resources for easy navigation
  • All headers are links
  • Links produce readable URL fragments (e.g. http://example.com/api#GET/users)
  • No collapsed elements make searching easy for browsers

Installation

npm install -g janrain/raml-fleece

Usage

raml-fleece api.raml > index.html

Custom Templates and Scripts

Custom Templates and scripts let you overwrite and extend the templates and scripts. See the command line help for details.

Thanks

This tool was originally built using raml2html.