# node-reveal

> Node CLI for reveal.js

Latest version **1.3.2** (published 2018-09-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-reveal
pnpm add node-reveal
yarn add node-reveal
bun add node-reveal
```

Provides the command `reveal`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2018-09-14 |
| First published | 2017-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 2.8 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Cody Chan |
| Maintainers | int64ago |
| Keywords | node, cli, reveal, reveal-js |

## Links

- npm: https://www.npmjs.com/package/node-reveal
- Repository: https://github.com/int64ago/node-reveal
- Homepage: https://github.com/int64ago/node-reveal#readme
- Issues: https://github.com/int64ago/node-reveal/issues
- npm.io page: https://npm.io/package/node-reveal

## Dependencies (6)

- [yargs](https://npm.io/package/yargs.md) ^7.0.2
- [chalklog](https://npm.io/package/chalklog.md) ^1.1.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^2.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.6.3
- [node-watch](https://npm.io/package/node-watch.md) ^0.4.1
- [browser-sync](https://npm.io/package/browser-sync.md) ^2.18.8

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.3.2 (latest) — 2018-09-14
- 1.1.0-beta.2 (beta) — 2017-03-11
- 1.3.1 — 2017-12-10
- 1.3.0 — 2017-06-14
- 1.2.2 — 2017-03-12
- 1.2.1 — 2017-03-12
- 1.2.0 — 2017-03-11
- 1.1.0 — 2017-03-11
- 1.1.0-beta.1 — 2017-03-11
- 1.0.0 — 2017-03-11
- 0.0.2-beta.0 — 2017-03-11
- 0.0.1 — 2017-02-27

## README

# node-reveal [![NPM version][npm-image]][npm-url]
Node CLI for [reveal.js](https://github.com/hakimel/reveal.js)

[A Real DEMO](https://github.com/int64ago/wasm)

## Feature

 - Fast and simple, almost one command
 - ONLY generate necessary files
 - Server in watch mode, auto reload during editing
 - Enable multiplex by default

## Usage

`npm i node-reveal -g` (or `yarn global add node-reveal`)

```text
$ reveal -h
Options:
  -i, --init     Create a new project.                  [default: "reveal-demo"]
  -w, --watch    Server in watch mode.                          [default: false]
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

```

#### Start

  - Init project: `reveal -i <your_project_name>`
  - Go to project directory: `cd <your_project_name>`
  - Server in watch mode: `reveal -w`

#### Quick start :heart:

  - Init project with default name: `reveal`
  - Go to project directory: `cd reveal-demo`
  - Server in watch mode: `reveal`

## Tips

 - ENOSPC error

`node-reveal` uses `node-watch` under the hood, for the limit of OS, you need to increase watchers limit manually, see [this](https://github.com/yuanchuan/node-watch/issues/48) for detail.


## GIF show

 - ONLY generate files needed
![](https://cloud.githubusercontent.com/assets/2230882/23828880/15b6c702-071b-11e7-88ac-d9d8605773c5.gif)

 - Create a project & server in watch mode
![](https://cloud.githubusercontent.com/assets/2230882/23828879/15b638d2-071b-11e7-8cbe-13c7e4b45ffc.gif)

 - Auto reload during editing
![](https://cloud.githubusercontent.com/assets/2230882/23828882/15f63586-071b-11e7-9086-4c7ece9d7c83.gif)

 - Enable multiplex in an elegant way
![](https://cloud.githubusercontent.com/assets/2230882/23828881/15f56570-071b-11e7-9062-0c4ffbf1734f.gif)

## License
MIT


[npm-url]: https://npmjs.org/package/node-reveal
[npm-image]: https://img.shields.io/npm/v/node-reveal.svg?style=flat-square

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