@@ -37,11 +37,11 @@ By doing this you would get a GitHub repo linked with Netlify in a way any chang
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:
npm run publish
npm run publish
And you’ll have your slides published to `http://USER.github.io/REPO/`.
@@ -4,31 +4,31 @@ All theme’s features are demonstrated in the [index.html](index.html) file. Us
-[Anatomy](#anatomy)
-[Common](#common)
-[Language](#language)
-[Canvas](#canvas)
-[Title](#title)
-[Badge](#badge)
-[Progress](#progress)
-[Language](#language)
-[Canvas](#canvas)
-[Title](#title)
-[Badge](#badge)
-[Progress](#progress)
-[Slide](#slide)
-[Number](#number)
-[Types](#types)
-[White](#white)
-[Black](#black)
-[Grid](#grid)
-[Content](#content)
-[Header](#header)
-[Paragraphs](#paragraphs)
-[Inline](#inline)
-[Quotes](#quotes)
-[Lists](#lists)
-[Columns](#columns)
-[Tables](#tables)
-[Code](#code)
-[Elements](#elements)
-[Cover](#cover)
-[Shout](#shout)
-[Place](#place)
-[Notes](#notes)
-[Number](#number)
-[Types](#types)
-[White](#white)
-[Black](#black)
-[Grid](#grid)
-[Content](#content)
-[Header](#header)
-[Paragraphs](#paragraphs)
-[Inline](#inline)
-[Quotes](#quotes)
-[Lists](#lists)
-[Columns](#columns)
-[Tables](#tables)
-[Code](#code)
-[Elements](#elements)
-[Cover](#cover)
-[Shout](#shout)
-[Place](#place)
-[Notes](#notes)
## Anatomy
...
...
@@ -51,8 +51,8 @@ In addition to files theme’s repository contains source files:
The main presentation language is set on the root element of the document, please note it and set the right one:
<html lang="en">
<html lang="ru">
<html lang="en">
<html lang="ru">
Appropriate typography traditions are used based on this value. `lang` attribute could also be set on separate slides or elements.
...
...
@@ -62,11 +62,11 @@ The root presentation element has the main `shower` class and additional mode cl
List:
<body class="shower list">
<body class="shower list">
Full:
<body class="shower full">
<body class="shower full">
Theme’s architecture is based on agreement that all presentation elements are nested in `shower` element and mode classes are hiding or showing needed elements depending on current mode.
...
...
@@ -74,10 +74,10 @@ Theme’s architecture is based on agreement that all presentation elements are
Presentation title is marked with the `caption` element, which has following elements provided: `<h1>` for the header, `<p>` for the description and also links.
<header class="caption">
<h1>Presentation Title</h1>
<p><a href="">Yours Truly</a>, Famous Inc.</p>
</header>
<header class="caption">
<h1>Presentation Title</h1>
<p><a href="">Yours Truly</a>, Famous Inc.</p>
</header>
Caption is visible only in the list mode. Don’t forget to also specify presentation title in document’s `<title>` element.
...
...
@@ -85,9 +85,9 @@ Caption is visible only in the list mode. Don’t forget to also specify present
Badge with “Fork me on GitHub” link (or any other call to action) is marked with `badge` element.
<footer class="badge">
<a href="…">Fork me on Github</a>
</footer>
<footer class="badge">
<a href="…">Fork me on Github</a>
</footer>
Badge is visible only in the list mode.
...
...
@@ -95,7 +95,7 @@ Badge is visible only in the list mode.
Progress bar shows how much is left until presentation end and marked with `progress` element visible only in full screen mode:
<div class="progress"></div>
<div class="progress"></div>
To remove it from presentation just remove this element from document. There’s no way to hide it for specific slides.
...
...
@@ -103,12 +103,12 @@ To remove it from presentation just remove this element from document. There’s
Slides are marked with `slide` class. Please don’t nest slides and don’t forget closing tags, things could go wrong.
<section class="slide">
…
</section>
<section class="slide">
…
</section>
<section class="slide">
…
</section>
<section class="slide">
…
</section>
There are two slide ratios supported: 16×10 and 4×3. To enable needed one include appropriate file `screen-4x3.css` or `screen-16x10.css`. Wide screen 16×10 format is included by default.
...
...
@@ -120,13 +120,13 @@ Slide numbers help audience to remember slides for questions and open needed sli
You can hide number manually:
<section class="slide" id="off">
<style>
#off::after {
visibility: hidden;
}
</style>
</section>
<section class="slide" id="off">
<style>
#off::after {
visibility: hidden;
}
</style>
</section>
Slide type `clear` could also hide slide number.
...
...
@@ -138,13 +138,13 @@ Types are changing slide’s look. You can set type by adding class to the main
White type sets white background.
<section class="slide white">
<section class="slide white">
#### Black
Black type sets black background.
<section class="slide black">
<section class="slide black">
Please note that black slide type doesn’t change text color.
...
...
@@ -152,15 +152,15 @@ Please note that black slide type doesn’t change text color.
Clear type turns off slide number. Use it when you need a pure slide. May be mixed with `white` or `black` type.
<section class="slide clear">
<section class="slide clear">
#### Grid
Grid set a background with two guide types: main magenta guides and additional cyan guides, setting margins, rows and columns.
<section class="slide grid">
…
</section>
<section class="slide grid">
…
</section>
All theme elements are aligned by this grid and it’s recommended to follow it while changing or extending a theme.
There are slides, which need to be described in only a few words. Usually they display a call for action, define common themes, link to project or something else. To stylize this text, use the `shout` class.
<section class="slide">
<h2 class="shout">Shout</h2>
</section>
<section class="slide">
<h2 class="shout">Shout</h2>
</section>
Add `grow` class to animate text from small to big size
<section class="slide">
<h2 class="shout grow">Growing Shout</h2>
</section>
<section class="slide">
<h2 class="shout grow">Growing Shout</h2>
</section>
Or, on the contrary, for animate text size from big to small add `shrink` class.
<section class="slide">
<h2 class="shout shrink">Shrinking Shout</h2>
</section>
<section class="slide">
<h2 class="shout shrink">Shrinking Shout</h2>
</section>
#### Place
Use `place` class on img attribute give same effect as `cover` class - set background image
<section class="slide">
<img class="place" src="picture.png">
</section>
<section class="slide">
<img class="place" src="picture.png">
</section>
If you want collocate picture at a certain side, you need to use `top` / `right` / `bottom` / `left` class as shown below
<img class="place top" src="picture.png">
<img class="place right" src="picture.png">
<img class="place bottom" src="picture.png">
<img class="place left" src="picture.png">
<img class="place top" src="picture.png">
<img class="place right" src="picture.png">
<img class="place bottom" src="picture.png">
<img class="place left" src="picture.png">
You can also combine classes for location in corners:
<pclass="note">Shower ['ʃəuə] noun. A person or thing that shows.</p>
</section>
<sectionclass="slide">
<h2>Plain text on your slides</h2>
<p>Lorem ipsum dolor sit amet, consectetur <ahref="#4">adipisicing</a> elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, <em>quis nostrud</em> exercitation ullamco laboris <strong>nisi ut aliquip</strong> ex ea commodo consequat. Duis aute irure <i>dolor</i> in reprehenderit in voluptate velit esse cillum <b>dolore</b> eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in <code><culpa></code> qui officia deserunt mollit anim id est laborum.</p>
</section>
<sectionclass="slide">
<h2>Two columns if you like</h2>
<divclass="columns two">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.</p>
<p>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia.</p>
</div>
</section>
<sectionclass="slide">
<h2>All kind of lists</h2>
<ol>
<li>Simple lists are marked with bullets</li>
<li>Ordered lists begin with a number</li>
<li>You can even nest lists one inside another
<ul>
<li>Or mix their types</li>
<li>But do not go too far</li>
<li>Otherwise audience will be bored</li>
</ul>
</li>
<li>Look, seven rows exactly!</li>
</ol>
</section>
<sectionclass="slide">
<h2>Serious citations</h2>
<figure>
<blockquote>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia.</p>
<pclass="note">Shower ['ʃəuə] noun. A person or thing that shows.</p>
</section>
<sectionclass="slide">
<h2>Plain text on your slides</h2>
<p>Lorem ipsum dolor sit amet, consectetur <ahref="#4">adipisicing</a> elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, <em>quis nostrud</em> exercitation ullamco laboris <strong>nisi ut aliquip</strong> ex ea commodo consequat. Duis aute irure <i>dolor</i> in reprehenderit in voluptate velit esse cillum <b>dolore</b> eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in <code><culpa></code> qui officia deserunt mollit anim id est laborum.</p>
</section>
<sectionclass="slide">
<h2>Two columns if you like</h2>
<divclass="columns two">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation.</p>
<p>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia.</p>
</div>
</section>
<sectionclass="slide">
<h2>All kind of lists</h2>
<ol>
<li>Simple lists are marked with bullets</li>
<li>Ordered lists begin with a number</li>
<li>You can even nest lists one inside another
<ul>
<li>Or mix their types</li>
<li>But do not go too far</li>
<li>Otherwise audience will be bored</li>
</ul>
</li>
<li>Look, seven rows exactly!</li>
</ol>
</section>
<sectionclass="slide">
<h2>Serious citations</h2>
<figure>
<blockquote>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia.</p>