ivan-igorevich
/
bmstu-mt-wp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
731 Commits 1 Branch 0 Tags 12 MiB
HTML 100%
Go to file
Vadim Makeev 9dcfc45f9f
Simplify copying steps 		2019-05-16 02:24:19 -04:00
docs added new way to copy project 2019-03-18 00:13:40 +03:00
pictures Update pictures 2019-01-19 16:39:21 +03:00
.editorconfig Moving from tabs to spaces 2018-08-24 11:48:59 +03:00
.gitignore chore(git): add presentation.pdf to .gitignore 2018-10-08 12:47:09 +03:00
.travis.yml Migrated with shower-cli 2019-02-09 01:43:39 +03:00
CONTRIBUTING.md Fix typos in Contributing.md 2016-02-15 13:56:35 +05:30
LICENSE.md Update copyright year 2019-02-11 14:21:04 +03:00
README.md Simplify copying steps 2019-05-16 02:24:19 -04:00
index.html Add universal sample year 2019-02-11 14:20:50 +03:00
netlify.toml Add Netlify support and Netlify button 2018-05-18 12:49:14 +02:00
package-lock.json Update path to the CLI package 2019-02-14 17:58:02 +03:00
package.json Update path to the CLI package 2019-02-14 17:58:02 +03:00

README.md

Shower Presentation Template Build Status

Shower logo

Shower ['ʃəuə] noun. A person or thing that shows.

  1. Built on HTML, CSS and vanilla JavaScript
  2. Works in all modern browsers
  3. Themes are separated from engine
  4. Fully keyboard accessible
  5. 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

  1. Download and unzip template archive
  2. 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.

Deploy 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

  1. Copy Shower in your account via GitHub or via CLI
  2. Install dependencies npm install and start it npm 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

  1. Open import page.
  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

  1. Сlone this repository git clone --depth=1 git@github.com:shower/shower.git, (--depth=1 will make it way faster).
  2. Create 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

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.