sashay

A library for generating API documentation from a RAML v0.8 definition.

Installation

npm install sashay

Usage

CLI

sashay [options] <source>

Use sashay --help for CLI reference.

JavaScript

var sashay = require('sashay')

sashay(options)

options Object

• destination String

  The build directory. Default './build/'.

• output Array

  The output format. Must be 'json' or 'web'. Default ['json'].

• quiet Boolean

  Set to true to suppress logs. Default false.

• source String

  The source file. Must be valid RAML. Required.

• watch Boolean

  Watches files for changes and rebuilds. In 'web' mode, starts a preview server at http://127.0.0.1:8000/. Default false.

• validate Boolean

  Whether to validate RAML schema or not.

Deploying website to AWS S3

Using the AWS CLI:

sashay index.raml -o web
aws s3 sync ./build/ s3://your-bucket/ \
    --exclude '*' \
    --include '*.js' \
    --include '*.css' \
    --include '*.html'

Publishing

1. Run make version v=x.x.x.
2. Create a pull request and merge.

License

See LICENSE.