summaryrefslogtreecommitdiff
path: root/public/docs
diff options
context:
space:
mode:
Diffstat (limited to 'public/docs')
-rw-r--r--public/docs/features.md15
-rw-r--r--public/docs/slide-example.md218
-rw-r--r--public/docs/yaml-metadata.md4
3 files changed, 215 insertions, 22 deletions
diff --git a/public/docs/features.md b/public/docs/features.md
index b64b988e..a894c087 100644
--- a/public/docs/features.md
+++ b/public/docs/features.md
@@ -47,12 +47,15 @@ or import content from your **clipboard** <i class="fa fa-clipboard"></i>, and t
It is possible to change the access permission to a note through the little button on the top right of the view.
There are four possible options:
-<i class="fa fa-leaf fa-fw"></i> **Freely**: Anyone can edit this note.
-<i class="fa fa-pencil fa-fw"></i> **Editable**: A signed-in user can edit this note.
-<i class="fa fa-id-card fa-fw"></i> **Limited**: People have to sign-in to view and edit this note.
-<i class="fa fa-lock fa-fw"></i> **Locked**: Anyone can view this note but only the owner can edit it.
-<i class="fa fa-umbrella fa-fw"></i> **Protected**: People have to sign-in to view this note but only owner can edit.
-<i class="fa fa-hand-stop-o fa-fw"></i> **Private**: Only the owner can view and edit this note.
+| |Owner read/write|Signed-in read|Signed-in write|Guest read|Guest write|
+|:-----------------------------|:--------------:|:------------:|:-------------:|:--------:|:---------:|
+|<span class="text-nowrap"><i class="fa fa-leaf fa-fw"></i> **Freely**</span> |✔|✔|✔|✔|✔|
+|<span class="text-nowrap"><i class="fa fa-pencil fa-fw"></i> **Editable**</span> |✔|✔|✔|✔|✖|
+|<span class="text-nowrap"><i class="fa fa-id-card fa-fw"></i> **Limited**</span> |✔|✔|✔|✖|✖|
+|<span class="text-nowrap"><i class="fa fa-lock fa-fw"></i> **Locked**</span> |✔|✔|✖|✔|✖|
+|<span class="text-nowrap"><i class="fa fa-umbrella fa-fw"></i> **Protected**</span> |✔|✔|✖|✖|✖|
+|<span class="text-nowrap"><i class="fa fa-hand-stop-o fa-fw"></i> **Private**</span> |✔|✖|✖|✖|✖|
+
**Only the owner of the note can change the note's permissions.**
diff --git a/public/docs/slide-example.md b/public/docs/slide-example.md
index 6249477f..e2e024b1 100644
--- a/public/docs/slide-example.md
+++ b/public/docs/slide-example.md
@@ -1,5 +1,10 @@
-Slide example
-===
+---
+slideOptions:
+ transition: slide
+---
+
+# Slide example
+
This feature still in beta, may have some issues.
For details please visit:
@@ -17,42 +22,80 @@ Is the divider of slides
----
-### First branch of first slide
+### First branch of first the slide
`----`
Is the divider of branches
+Use the _Space_ key to navigate through all slides.
+
----
-### Second branch of first slide
+### Second branch of first the slide
+
+Nested slides are useful for adding additional detail underneath a high-level horizontal slide.
+
+---
+
+## Point of View
+
+Press **ESC** to enter the slide overview.
+
+---
+
+## Touch Optimized
+
+Presentations look great on touch devices, like mobile phones and tablets. Simply swipe through your slides.
+
+---
+
+## Fragments
`<!-- .element: class="fragment" data-fragment-index="1" -->`
Is the fragment syntax
-- Item 1<!-- .element: class="fragment" data-fragment-index="1" -->
-- Item 2<!-- .element: class="fragment" data-fragment-index="2" -->
+Hit the next arrow...
+
+... to step through ...
+
+<span>... a<!-- .element: class="fragment" data-fragment-index="1" --></span> <span>fragmented<!-- .element: class="fragment" data-fragment-index="2" --></span> <span>slide.<!-- .element: class="fragment" data-fragment-index="3" --></span>
+
+Note:
+ This slide has fragments which are also stepped through in the notes window.
---
-## Second slide
+## Fragment Styles
-<!-- .slide: data-background="#1A237E" -->
+There are different types of fragments, like:
-`<!-- .slide: data-background="#1A237E" -->`
+grow
-Is the background syntax
+shrink
+
+fade-out
+
+fade-up (also down, left and right!)
+
+current-visible
+
+Highlight <span><!-- .element: class="fragment highlight-red" -->red</span> <span><!-- .element: class="fragment highlight-blue" -->blue</span> <span><!-- .element: class="fragment highlight-green"-->green</span>
---
<!-- .slide: data-transition="zoom" -->
+## Transition Styles
+Different background transitions are available via the transition option. This one's called "zoom".
+
`<!-- .slide: data-transition="zoom" -->`
Is the transition syntax
-you can use:
+You can use:
+
none/fade/slide/convex/concave/zoom
---
@@ -61,10 +104,12 @@ none/fade/slide/convex/concave/zoom
`<!-- .slide: data-transition="fade-in convex-out" -->`
-Also can set different in/out transition
+Also, you can set different in/out transition
+
+You can use:
+
+none/fade/slide/convex/concave/zoom
-you can use:
-none/fade/slide/convex/concave/zoom
postfix with `-in` or `-out`
---
@@ -75,9 +120,150 @@ postfix with `-in` or `-out`
Custom the transition speed!
-you can use:
+You can use:
+
default/fast/slow
---
-# The End \ No newline at end of file
+## Themes
+
+reveal.js comes with a few themes built in:
+
+Black (default) - White - League - Sky - Beige - Simple
+
+Serif - Blood - Night - Moon - Solarized
+
+It can be set in YAML slideOptions
+
+---
+
+<!-- .slide: data-background="#1A237E" -->
+
+`<!-- .slide: data-background="#1A237E" -->`
+
+Is the background syntax
+
+---
+
+<!-- .slide: data-background="https://s3.amazonaws.com/hakim-static/reveal-js/image-placeholder.png" data-background-color="#005" -->
+
+<div style="color: #fff;">
+
+## Image Backgrounds
+
+`<!-- .slide: data-background="image.png"-->`
+
+</div>
+
+----
+
+<!-- .slide: data-background="https://s3.amazonaws.com/hakim-static/reveal-js/image-placeholder.png" data-background-repeat="repeat" data-background-size="100px" data-background-color="#005" -->
+
+<div style="color: #fff;">
+
+## Tiled Backgrounds
+
+`<!-- .slide: data-background="image.png" data-background-repeat="repeat" data-background-size="100px" -->`
+
+</div>
+
+----
+
+<!-- .slide: data-background-video="https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.mp4,https://s3.amazonaws.com/static.slid.es/site/homepage/v1/homepage-video-editor.webm" data-background-color="#000000" -->
+
+<div style="background-color: rgba(0, 0, 0, 0.9); color: #fff; padding: 20px;">
+
+## Video Backgrounds
+
+`<!-- .slide: data-background-video="video.mp4,video.webm" -->`
+
+</div>
+
+----
+
+<!-- .slide: data-background="http://i.giphy.com/90F8aUepslB84.gif" -->
+
+## ... and GIFs!
+
+---
+
+## Pretty Code
+
+``` javascript
+function linkify( selector ) {
+ if( supports3DTransforms ) {
+
+ const nodes = document.querySelectorAll( selector );
+
+ for( const i = 0, len = nodes.length; i < len; i++ ) {
+ var node = nodes[i];
+
+ if( !node.className ) {
+ node.className += ' roll';
+ }
+ }
+ }
+}
+```
+Code syntax highlighting courtesy of [highlight.js](http://softwaremaniacs.org/soft/highlight/en/description/).
+
+---
+
+## Marvelous List
+
+- No order here
+- Or here
+- Or here
+- Or here
+
+---
+
+## Fantastic Ordered List
+
+1. One is smaller than...
+2. Two is smaller than...
+3. Three!
+
+---
+
+## Tabular Tables
+
+| Item | Value | Quantity |
+| ---- | ----- | -------- |
+| Apples | $1 | 7 |
+| Lemonade | $2 | 18 |
+| Bread | $3 | 2 |
+
+---
+
+## Clever Quotes
+
+> “For years there has been a theory that millions of monkeys typing at random on millions of typewriters would reproduce the entire works of Shakespeare. The Internet has proven this theory to be untrue.”
+
+---
+
+## Intergalactic Interconnections
+
+You can link between slides internally, [like this](#/1/3).
+
+---
+
+## Speaker
+
+There's a [speaker view](https://github.com/hakimel/reveal.js#speaker-notes). It includes a timer, preview of the upcoming slide as well as your speaker notes.
+
+Press the _S_ key to try it out.
+
+Note:
+ Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit `s` on your keyboard).
+
+---
+
+## Take a Moment
+
+Press `B` or `.` on your keyboard to pause the presentation. This is helpful when you're on stage and want to take distracting slides off the screen.
+
+---
+
+# The End
diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md
index 7158104b..d49418f6 100644
--- a/public/docs/yaml-metadata.md
+++ b/public/docs/yaml-metadata.md
@@ -134,6 +134,9 @@ This option allow you provide custom options to slide mode.
Please below document for more details:
https://github.com/hakimel/reveal.js/#configuration
+You could also set slide theme which named in below css files:
+https://github.com/hakimel/reveal.js/tree/master/css/theme
+
**Notice: always use two spaces as indention in YAML metadata!**
> default: not set (which use default slide options)
@@ -142,4 +145,5 @@ https://github.com/hakimel/reveal.js/#configuration
```xml
slideOptions:
transition: fade
+ theme: white
``` \ No newline at end of file