node-reveal
Version:
Node CLI for reveal.js
66 lines (42 loc) • 2.01 kB
Markdown
# 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
- Create a project & server in watch mode
- Auto reload during editing
- Enable multiplex in an elegant way
## License
MIT
[npm-url]: https://npmjs.org/package/node-reveal
[npm-image]: https://img.shields.io/npm/v/node-reveal.svg?style=flat-square