shower
v2.7.1
Published
Shower HTML presentation engine
Downloads
135
Maintainers
Readme
Shower Presentation Template
Shower ['ʃəuə] noun. A person or thing that shows.
- Built on HTML, CSS and vanilla JavaScript
- Works in all modern browsers
- Themes are separated from engine
- Fully keyboard accessible
- Printable to PDF
See it in action. Includes Ribbon and Material themes, and core with plugins.
Follow @shower_me for support and updates, file an issue if you have any.
Quick Start
- Download and unzip template archive
- Open
index.html
and start creating your presentation
Deploy to Netlify
By clicking the button below you can fork this repo and deploy it to Netlify.
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.
Advanced
Get your own Shower
- Copy Shower in your account via GitHub or via CLI
- Install dependencies
npm install
and start itnpm start
.
Once you’re done you can build a clean copy of your slides:
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:
npm run publish
And you’ll have your slides published to http://USER.github.io/REPO/
.
Copy via GitHub
- Open import page.
- For the repository URL use
https://github.com/shower/shower
. - For the name use any name you want, your presentation name would be the best.
- Clone the resulted repository to your computer.
Copy via CLI
- Сlone this repository
git clone --depth=1 [email protected]:shower/shower.git
, (--depth=1
will make it way faster). - Create a new blank repository and copy its cloning address
[email protected]:USER/REPO.git
. - Change remote of your local clone to the one you’ve just copied
git remote set-url origin [email protected]:USER/REPO.git
. - Push your local clone to GitHub
git push -u origin master
.
Usage Examples
Browser Support
Latest stable versions of Chrome, Edge, Firefox, and Safari are supported.
Contributing
You’re always welcome to contribute. Fork project, make changes and send it as pull request. But it’s better to file an issue with your idea first. Read contributing rules for more details.
Main contributors in historical order: pepelsbey, jahson, miripiruni, kizu, artpolikarpov, tonyganch, zloylos.
Licensed under MIT License.