readme.md

Shower CLI

Command line interface for Shower

Quick Creating Slides

npx shower-cli create my-slides

(npx comes with npm 5.2+ and higher)

Installation

Install ShowerCLI using npm:

$ npm install --global shower-cli

or via yarn:

$ yarn global add shower-cli

The minimum supported Node version is v8.0.0 by default.

Note: For easy creation of slides for one command, we recommend installing the ShowerCLI globally. After the presentation is created, ShowerCLI is added as dev-dependencies by default

Usage:

shower [--version] [--help] <command> [<args>]

Create presentation

$ shower create [<directory>] - Creating a new project

Run development server

$ shower serve - Serve a the presentation in development mode

Prepare presentation

$ shower prepare - Gather the necessary files in a separate folder

Create an archive of the prepared presentation

$ shower archive - To create an archive of the presentation

Convert presentation to PDF

$ shower pdf - Converts the presentation to PDF

Publish presentation with GitHub Pages

$ shower publish - Publish your project to GitHub Pages