https://github.com/aikoven/slice2md

Compiles Slice files to Markdown.
https://github.com/aikoven/slice2md

Last synced: 3 days ago
JSON representation

Compiles Slice files to Markdown.

• Host: GitHub
• URL: https://github.com/aikoven/slice2md
• Owner: aikoven
• Created: 2019-10-04T07:20:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T12:03:32.000Z (almost 2 years ago)
• Last Synced: 2024-11-08T10:33:28.835Z (about 2 months ago)
• Language: TypeScript
• Size: 596 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# slice2md [![npm version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]

Compiles Slice files to Markdown.

## Installation

    $ yarn add slice2md

## Usage

    Usage: slice2md [options] 

    Options:

      -V, --version         output the version number

      -e, --exclude   File paths or globs to exclude.

      -o, --out-dir    Directory where to put generated files.

      -h, --help            output usage information

## API

```ts

import {slice2md} from 'slice2md';

slice2md(options); // Promise;

```

Options interface:

```ts

{

  /**

   * 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;

}

```

[npm-image]: https://badge.fury.io/js/slice2md.svg

[npm-url]: https://badge.fury.io/js/slice2md

[travis-image]: https://travis-ci.org/aikoven/slice2md.svg?branch=master

[travis-url]: https://travis-ci.org/aikoven/slice2md