npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sashay

v5.0.1

Published

A documentation generator for the Percolate API.

Downloads

42

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

christophercliffchristophercliffgmathieugmathieu

Keywords

Readme

sashay

Circle CI codecov.io

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.