xampl

CLI tools and SDK for xampl

Project Status

Documentation

Full API documentation - Learn about each method

Why?

Xampl makes it easy to manage and publish examples for your library. It also allows for the community to contribute examples that are easy to find and experiment with.

Features

TODO

• [ ] Publish examples for the given library to xampl

Install

npm install --save-dev xampl

Usage

Xampl can be used as a binary or programmatically.

Using the Binary

You can using the binary directly by installing globally

npm install -g firemin

Publish your examples after deploying a new version of your library by simply running...

xampl publish

This will scan the project for a package.json which it will use to identify the package name and version. It will also scan the project for all *.xampl files. Every example contained in those files will be independently published.

Using Programmatically

To do so, simply install xampl as a project dependency and then import the necessary methods from the xampl package

npm install --save xampl

import { publish } from 'xampl'

await publish('./path/to/project')