Commit 4df5100d authored by vrnnncl's avatar vrnnncl

ummmmmm........

parent a7c87ee0
# Contributing to Shower
You’re always welcome to contribute! Before contributing to Shower, please read through unified [issues list](https://github.com/shower/shower/issues) to see open bugs and feature requests. If you have any feature to add to Shower or found a bug and want to fix it, please make sure you [file an issue](https://github.com/shower/shower/issues/new) first.
## Process
Fork needed repository, create a branch for each feature or issue you’re dealing with and start making changes. Make sure you code doesn’t break tests if there are any. Once you’re finished, send pull request back to original repository: one feature or bug fix — one pull request, please don’t combine non-relevant changes into one pull request. Supply clear description of your changes and a link to existing issue.
## Code style
Please preserve existing code style while contributing to Shower and be ready for code review by Shower maintainers. It’s strongly recommended to install [EditorConfig](http://editorconfig.org) extension to your editor and validate your JavaScript changes using [JSHint](http://jshint.com/).
## Language
English is the main language for Shower project. All discussions and commit messages should be in English, no matter if it’s good or bad. The second language of Shower is Russian. Official Shower themes are always compatible with Cyrillic and Russian typography. All documentation to Shower is always localized to Russian.
---
Licensed under [MIT License](LICENSE.md).
# The MIT License
Copyright © 2010–2021 Vadim Makeev, http://pepelsbey.net/
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
---
# Лицензия MIT
Copyright © 2010–2021 Вадим Макеев, http://pepelsbey.net/
Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, добавление, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, также как и лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:
Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.
ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ ТРЕБОВАНИЙ ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ, ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.
# Shower Presentation Template
[![Test status](https://github.com/shower/shower/workflows/Test/badge.svg)](https://github.com/shower/shower/actions/workflows/test.yml)
<img src="pictures/logo.png" width="250" alt="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](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.
## Quick Start
1. Download and unzip [shower.zip](http://shwr.me/shower.zip) template archive.
2. Open `index.html` in any text editor and start creating your presentation.
## Quick Start via CLI
You’ll need [Node.js](https://nodejs.org/) installed on your computer.
1. Install Shower CLI utility: `npm install -g @shower/cli`.
2. Create your presentation: `shower create`.
Read more on [shower/cli](https://github.com/shower/cli/) page.
## Quick Start with Hosting
You’ll need [Node.js](https://nodejs.org/) installed on your computer.
1. Copy this repository to your account via GitHub.
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:
npm run bundle
You’ll find your presentation in `bundled` folder. You can also run `npm run archive` to get the same files in `presentation.zip`.
Publish your presentation online by running:
npm run publish
You’ll have your slides published to `https://USER.github.io/REPO/`.
## Deploy to Netlify
By clicking the button below you can fork this repo and deploy it to Netlify.
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](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 an easy way to create and share Shower presentation without the need to install anything locally.
## 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](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), [zloylos](https://github.com/zloylos), [shvaikalesh](https://github.com/shvaikalesh).
---
Licensed under [MIT License](LICENSE.md).
This diff is collapsed.
# Logitech Spotlight
There’s a brand new [Logitech Spotlight](http://www.logitech.com/en-us/product/spotlight-presentation-remote) presentation remote, which is already fully compatible with Shower: you can switch between slides, hover and click your presentation. But you can make the most of it by enabling two additional shortcuts in Logitech Presentation application, available for macOS and Windows.
1. [Download](http://support.logitech.com/en_us/software/logi-presentation) and install an app.
2. Go to the main menu and locate additional shortcuts options.
3. Change _Hold Next Button_ to `Cmd Enter` for macOS or `Shift F5` for Windows (just press it).
4. Change _Hold Back Button_ to `Esc` (just press it).
<img src="images/logitech.png" width="300" alt="Logitech Presenter application">
You might have to enable accessibility access on macOS in order to use this features. App will ask you once it’s needed.
Now when all is set you can:
- Start your presentation by holding next button: from the first slide (if none selected) or from the current slide (if there’s one).
- Exit full screen mode by holding back button. It might be useful when you need to find a certain slide and navigate the list.
# Export to PDF
Though publishing your HTML slides as they are is always a better idea, you can export your presentation to PDF to upload it to a service like [SlideShare](https://www.slideshare.net/) or [Notist](https://noti.st/).
There are two ways of doing this: via browser print dialog or via console. Exporting via browser seems like the most convenient option, but in some cases it might take too much time or even freeze your browser if your slides are too heavy or there are too many of them.
## Browser
To export your slides to PDF using a browser, you’ll need a browser that’s capable of reading page size from `@page` CSS rule. Chromium-based browsers such as Chrome, Opera, Yandex work the best.
Open you presentation in a browser and send it to print:
1. Press <kbd>Cmd P</kbd> or <kbd>Ctrl P</kbd>.
2. Select PDF as a target instead of printer.
3. Save resulted file.
![Printing dialog](images/ribbon-printing.png)
## Console
To export your slides to PDF via console, you’ll need [Node.js](https://nodejs.org/) with npm installed. Once you have it, you can install Shower CLI package that’ll take care of export:
```sh
npm install -g @shower/cli
```
Once it’s installed, it becomes globally available as `shower` command. Run it in your presentation’s folder like this to get your PDF:
```sh
shower pdf
```
Run `shower --help` for more options. But if it’s a one-time thing and you don’t want to install it globally, you can use built-in command coming with Shower main repository:
```sh
npm install
npm run pdf
```
You’ll find `index.pdf` next to your slides.
# Keyboard Shortcuts
You can navigate between slides, start and stop presentation using keyboard shortcuts.
- [Start and Stop](#start-and-stop)
- [Forward](#forward)
- [Backward](#backward)
- [First and Last](#first-and-last)
## Start and Stop
- Start from the current slide: `Cmd Enter`, `Shift F5`, `Cmd Option P`
- Start from the first slide `Cmd Shift Enter`
- Stop: `Esc` key
## Forward
- `Right` and `Down` arrows
- `Page Down` key or `Fn Down` on Mac
- `N` for “next”, `J` or `L` keys
- `Enter` key
- `Space` key during presentation
## Backward
- `Left` and `Up` arrows
- `Page Up` key or `Fn Up` on Mac
- `P` for “previous”, `K` or `H` keys, like in vim
- `Shift Enter` key
- `Shift Space` key during presentation
## First and Last
- First slide: `Home` key or `Fn Left` on Mac
- Last slide: `End` key or `Fn Right` on Mac
[build]
publish = "bundled"
command = "npm run bundle"
This diff is collapsed.
{
"name": "@shower/shower",
"description": "Shower HTML presentation engine",
"version": "3.3.0",
"author": {
"name": "Vadim Makeev",
"url": "https://pepelsbey.net/"
},
"homepage": "https://github.com/shower/shower",
"repository": {
"type": "git",
"url": "git://github.com/shower/shower.git"
},
"bugs": {
"url": "https://github.com/shower/shower/issues"
},
"license": "MIT",
"keywords": [
"shower",
"presentation",
"template"
],
"files": [
"pictures/**",
"index.html",
"LICENSE.md",
"README.md"
],
"dependencies": {
"@shower/core": "^3.3.0",
"@shower/material": "^2.5.0",
"@shower/ribbon": "^3.5.0"
},
"devDependencies": {
"@shower/cli": "^0.3.1",
"path-exists-cli": "^2.0.0"
},
"private": true,
"scripts": {
"pdf": "shower pdf",
"start": "shower serve",
"bundle": "shower bundle --files '**' --files '!{docs,node_modules,bundled}{,/**}' --files '!*.{md,toml,json}'",
"archive": "shower archive --files '**' --files '!{docs,node_modules,bundled}{,/**}' --files '!*.{md,toml,json}'",
"publish": "shower publish --files '**' --files '!{docs,node_modules,bundled}{,/**}' --files '!*.{md,toml,json}'",
"test": "npm run bundle && ls bundled && npm run archive && path-exists presentation.zip"
"serve": "shower serve",
"archive": "shower archive",
"bundle": "shower bundle",
"publish": "shower publish"
},
"devDependencies": {
"@shower/cli": "^0.3.1"
}
}
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500 500"><path fill="#4b86c2" d="M327.5 273.5l17.7-17.7L500 410.7v-35.4L362.8 238.1l17.7-17.7L500 339.9v-35.4L398.2 202.8l17.7-17.7 84.1 84.1V50c0-27.6-22.4-50-50-50H50C22.4 0 0 22.4 0 50v400c0 27.6 22.4 50 50 50h214.3c4.9-20.5-.7-42.9-16.7-58.9L186 379.5 124.5 318c-53.9-53.9-54.1-141.1-.4-194.8 53.7-53.7 140.9-53.6 194.8.3l8.5 8.5h106.1L274 291.1v-106l-8.3-8.5c-24.5-24.5-64-24.6-88.4-.2s-24.3 64.1.2 88.5l61.5 61.5 61.5 61.5c30.6 30.6 43.9 72.1 39.8 112H450c27.6 0 50-22.4 50-50v-4L327.5 273.5z"/></svg>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment