ivan-igorevich
/
bmstu-mt-wp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bmstu-mt-wp/README.md

3.3 KiB
Raw Blame History

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. Modular and extensible
  5. Fully keyboard accessible
  6. 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

  1. Clone this repository locally git clone git@github.com:shower/shower.git.
  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.
  5. 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/.

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.