# slice2md

> Compiles Slice files to Markdown.

Latest version **0.1.1** (published 2019-10-04) · GPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install slice2md
pnpm add slice2md
yarn add slice2md
bun add slice2md
```

Provides the command `slice2md`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-10-04 |
| First published | 2019-10-04 |
| Weekly downloads | 0 |
| License | GPL-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 98.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Daniel Lytkin |
| Maintainers | aikoven |

## Links

- npm: https://www.npmjs.com/package/slice2md
- Repository: https://github.com/aikoven/slice2md
- Homepage: https://github.com/aikoven/slice2md#readme
- Issues: https://github.com/aikoven/slice2md/issues
- npm.io page: https://npm.io/package/slice2md

## Dependencies (9)

- [glob](https://npm.io/package/glob.md) ^7.1.4
- [dedent](https://npm.io/package/dedent.md) ^0.7.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [slice2json](https://npm.io/package/slice2json.md) ^0.2.0
- [assert-never](https://npm.io/package/assert-never.md) ^1.2.0
- [indent-string](https://npm.io/package/indent-string.md) ^4.0.0
- [markdown-table](https://npm.io/package/markdown-table.md) ^1.1.3

## Recent versions

- 0.1.1 (latest) — 2019-10-04
- 0.1.0 — 2019-10-04

## 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] <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

```ts
import {slice2md} from 'slice2md';

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

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

---
_Source: https://npm.io/package/slice2md · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._