GithubHelp home page GithubHelp logo

dcrossleyau / raml-fleece Goto Github PK

View Code? Open in Web Editor NEW

This project forked from janrain/raml-fleece

0.0 2.0 0.0 95 KB

Tool for converting RAML to HTML documentation

License: MIT License

JavaScript 52.33% HTML 34.25% CSS 13.42%

raml-fleece's Introduction

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.

raml-fleece's People

Contributors

akameron avatar bmatsuo1 avatar dcrossleyau avatar paulo-akamai avatar pearcedavis avatar rdenmark avatar sapphirejanrain avatar tcmitche avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.