From 982a04b0effbf89afa3674b788719571b69d018c Mon Sep 17 00:00:00 2001 From: Anton Date: Tue, 2 Mar 2021 15:35:57 +0200 Subject: [PATCH] Added information about `spotlight` element (#369) Was ordered elements by alphabet in the Elements section. Also fixed some small mistakes. --- docs/features.md | 125 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 99 insertions(+), 26 deletions(-) diff --git a/docs/features.md b/docs/features.md index 531e35c..79f08ee 100644 --- a/docs/features.md +++ b/docs/features.md @@ -26,9 +26,10 @@ All theme’s features are demonstrated in the [index.html](index.html) file. Us - [Code](#code) - [Elements](#elements) - [Cover](#cover) - - [Shout](#shout) - - [Place](#place) - [Notes](#notes) + - [Place](#place) + - [Shout](#shout) + - [Spotlight](#spotlight) ## Anatomy @@ -112,7 +113,7 @@ Slides are marked with `slide` class. Please don’t nest slides and don’t for 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. -Slide width is 1024 px for the both ratios, for 16×10 height is 640 px, for 4×3 it’s 768. Bare in mind these sizes while preparing presentation pictures. In list mode slides are scaled down 2 or 4 times and in full screen mode they are scaled dynamically based on window size. +Slide width is 1024 px for the both ratios, for 16×10 height is 640 px, for 4×3 it’s 768. Bear in mind these sizes while preparing presentation pictures. In list mode slides are scaled down 2 or 4 times and in full screen mode they are scaled dynamically based on window size. ### Number @@ -206,7 +207,7 @@ Quotes are marked with `
` element which contains one or more paragra

Flannel bicycle rights locavore selfies.

-To add quote’s author wrap a quote to a `
` element and put a caption in the `
` right after: +To add a quote’s author wrap a quote to a `
` element and put a caption in the `
` right after:
@@ -305,7 +306,7 @@ If you want to add lines numbers use next construction: } -When neccessary emphasize that code is commented, you need to use span element with `comment` class; +When necessary emphasize that code is commented, you need to use span element with `comment` class; If you want to color part of code, wrap this part with `mark` to add yellow background and `mark` with `important` class to add red background;
function action() {
@@ -347,24 +348,15 @@ To insert an image description, links to the author's site or other information
         
-#### Shout +#### Notes -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. +When necessary to add some notes for a slide, you may use `footer` class, that hide your notes at all time and show them when you hover to slide:
-

Shout

-
- -Add `grow` class to animate text from small to big size - -
-

Growing Shout

-
- -Or, on the contrary, for animate text size from big to small add `shrink` class. - -
-

Shrinking Shout

+

Retro meh brunch aesthetic.

+
+

Cosby sweater Shoreditch.

+
#### Place @@ -389,13 +381,94 @@ You can also combine classes for location in corners: -#### Notes +#### Shout -When neccessary to add some notes for slide, you may use `footer` class, that hide your notes at all time and show them when you hover to slide: +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.
-

Retro meh brunch aesthetic.

-
-

Cosby sweater Shoreditch.

-
+

Shout

+ +Add `grow` class to animate text from small to big size + +
+

Growing Shout

+
+ +Or, on the contrary, for animate text size from big to small add `shrink` class. + +
+

Shrinking Shout

+
+ +#### Spotlight + +When necessary, to spotlight some part of the slide, you may use the `spotlight` class: + +
+

Round spotlight

+
+
+ +It can be combined with `place` class and `top` / `right` / `bottom` / `left` classes: + +
+

Round spotlight in the corner

+
+
+ +You can also use the `next` class for inner navigation: + +
+

Spotlight with inner naviagation

+
    +
  1. I'll be seen right away.
  2. +
  3. Just navigate to next slide and you'll see others.
  4. + + +
+ +
+ +You can create custom `style` for the spotlight element, e.g., stripe spotlight: + +
+

Stripe spotlight

+ +
+
+ +You can also create CSS animation: + +
+

Spotlight with animation

+ + +
+ +> Please remember that you should duplicate slides with and without a spotlight for the PDF version because PDF format doesn't support animation.