📦 [npm] Node CLI for reveal.js
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets/lib
reveal.js @ 43eada7
src
template
.gitignore
.gitmodules
.npmignore
Dockerfile
LICENSE
README.md
index.js
package.json

README.md

node-reveal NPM version

Node CLI for reveal.js

A Real DEMO

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)

$ 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 ❤️

  • 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 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