> Shower ['ʃəuə] noun. A person or thing that shows.
> Shower ['ʃəuə] noun. A person or thing that shows.
1. Built on HTML, CSS and vanilla JavaScript
1. Built on HTML, CSS and vanilla JavaScript.
2. Works in all modern browsers
2. Works in all modern browsers.
3. Themes are separated from engine
3. Themes are separated from engine.
4. Fully keyboard accessible
4. Fully keyboard accessible.
5. Printable to PDF
5. Printable to PDF.
[See it in action](http://shwr.me/). Includes [Ribbon](https://github.com/shower/ribbon/) and [Material](https://github.com/shower/material/) themes, and [core](https://github.com/shower/core/) with plugins.
[See it in action](https://shwr.me/). Includes [Ribbon](https://github.com/shower/ribbon/) and [Material](https://github.com/shower/material/) themes, and [core](https://github.com/shower/core/) with plugins.
Follow [@shower_me](https://twitter.com/shower_me) for support and updates, [file an issue](https://github.com/shower/shower/issues/new) if you have any.
Follow [@shower_me](https://twitter.com/shower_me) for support and updates, [file an issue](https://github.com/shower/shower/issues/new) if you have any.
## Quick Start
## Quick Start
1. Download and unzip [template archive](http://shwr.me/shower.zip)
1. Download and unzip [shower.zip](http://shwr.me/shower.zip) template archive.
2. Open `index.html`and start creating your presentation
2. Open `index.html`in any test editor and start creating your presentation.
## Deploy to Netlify
## Quick Start via CLI
By clicking the button below you can fork this repo and deploy it to Netlify.
You’ll need [Node.js](https://nodejs.org/) installed on your computer.
[](https://app.netlify.com/start/deploy?repository=https://github.com/shower/shower)
By doing this you would get a GitHub repo linked with Netlify in a way any change to the repo would trigger a shower rebuild and deploy to Netlify servers, which allows for a really easy way to create and share Shower presentation without the need to install anything locally.
Read more on [shower/cli](https://github.com/shower/cli/) page.
## Advanced
## Quick Start with Hosting
### Get your own Shower
You’ll need [Node.js](https://nodejs.org/) installed on your computer.
1. Copy Shower in your account via [GitHub](#copy-via-github) or via [CLI](#copy-via-cli)
1. Copy this repository to your account via GitHub.
2. Install dependencies `npm install` and start it `npm start`.
1. Open [import page](https://github.com/new/import).
2. Use `https://github.com/shower/shower` for the repository URL
3. Use your presentation name.
4. Clone the resulted repository to your computer.
2. Install dependencies `npm install` and start a local server `npm start`.
3. Start editing your slides with live-reload.
Once you’re done you can build a clean copy of your slides:
Once you’re done you can build a clean copy of your slides:
npm run prepare
npm run prepare
And you’ll find your presentation in `prepared` folder with only needed files in it. You can also run `npm run archive` to get the same files in `archive.zip`. But there’s more! You can easily publish your presentation online by running:
You’ll find your presentation in `prepared` folder. You can also run `npm run archive` to get the same files in `presentation.zip`.
npm run publish
And you’ll have your slides published to `http://USER.github.io/REPO/`.
Publish your presentation online by running:
#### Copy via GitHub
npm run publish
1. Open [import page](https://github.com/new/import).
You’ll have your slides published to `https://USER.github.io/REPO/`.
2. For the repository URL use `https://github.com/shower/shower`.
3. For the name use any name you want, your presentation name would be the best.
4. Clone the resulted repository to your computer.
#### Copy via CLI
## Deploy to Netlify
1. Сlone this repository `git clone --depth=1 git@github.com:shower/shower.git`, (`--depth=1` will make it way faster).
By clicking the button below you can fork this repo and deploy it to Netlify.
2.[Create](https://github.com/new) a new blank repository and copy its cloning address `git@github.com:USER/REPO.git`.
3. Change remote of your local clone to the one you’ve just copied `git remote set-url origin git@github.com:USER/REPO.git`.
4. Push your local clone to GitHub `git push -u origin master`.
## Usage Examples
[](https://app.netlify.com/start/deploy?repository=https://github.com/shower/shower)
-[Semantic for cynics](https://pepelsbey.net/pres/semantics/en/)
By doing this you would get a GitHub repo linked with Netlify in a way any change to the repo would trigger a Shower rebuild and deploy to Netlify servers, which allows for an easy way to create and share Shower presentation without the need to install anything locally.
-[I’m in IoT](https://pepelsbey.net/pres/im-in-iot/)
## Browser Support
## Browser Support
...
@@ -74,7 +69,7 @@ Latest stable versions of Chrome, Edge, Firefox, and Safari are supported.
...
@@ -74,7 +69,7 @@ Latest stable versions of Chrome, Edge, Firefox, and Safari are supported.
You’re always welcome to contribute. Fork project, make changes and send it as pull request. But it’s better to file an [issue](https://github.com/shower/shower/issues) with your idea first. Read [contributing rules](CONTRIBUTING.md) for more details.
You’re always welcome to contribute. Fork project, make changes and send it as pull request. But it’s better to file an [issue](https://github.com/shower/shower/issues) with your idea first. Read [contributing rules](CONTRIBUTING.md) for more details.
Main contributors in historical order: [pepelsbey](https://github.com/pepelsbey), [jahson](https://github.com/jahson), [miripiruni](https://github.com/miripiruni), [kizu](https://github.com/kizu), [artpolikarpov](https://github.com/artpolikarpov), [tonyganch](https://github.com/tonyganch), [zloylos](https://github.com/zloylos).
Main contributors in historical order: [pepelsbey](https://github.com/pepelsbey), [jahson](https://github.com/jahson), [miripiruni](https://github.com/miripiruni), [kizu](https://github.com/kizu), [artpolikarpov](https://github.com/artpolikarpov), [tonyganch](https://github.com/tonyganch), [zloylos](https://github.com/zloylos), [zloylos](https://github.com/zloylos), [shvaikalesh](https://github.com/shvaikalesh).
