slice2md v0.1.1

slice2md

Compiles Slice files to Markdown.

Installation

$ yarn add slice2md

Usage

Usage: slice2md [options] <file ...>

Options:

  -V, --version         output the version number
  -e, --exclude <file>  File paths or globs to exclude.
  -o, --out-dir <dir>   Directory where to put generated files.
  -h, --help            output usage information

API

import {slice2md} from 'slice2md';

slice2md(options); // Promise<void>;

Options interface:

{
  /**
   * Array of slice file paths or globs.
   */
  files: string[];
  /**
   * Array of file paths or globs to exclude.
   */
  exclude?: string[];
  /**
   * Directory where to put generated files.
   */
  outDir: string;
}