jxnblk/mdx-deck
1
1
Fork 0
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-11-26 00:35:02 +03:00
Code Issues Projects Releases Wiki Activity

Edit docs

Browse Source
This commit is contained in:
Brent Jackson 2018-08-28 18:08:04 -04:00
parent 1747e6b629
commit 88be9ea6e8
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -250,15 +250,17 @@ This shows a list of all slides on the left and a preview of the current slide o
Key | Description
---|---
Left Arrow | Go to previous slide
Right Arrow | Go to next slide
Space | Go to next slide
Up Arrow | Hide current step in [Appear](#appear) component
Down Arrow | Show next step in [Appear](#appear) component
Left Arrow | Go to previous slide or step in [Appear][]
Right Arrow | Go to next slide or step in [Appear][]
Space | Go to next slide or step in [Appear][]
Up Arrow | Hide current step in [Appear][] component
Down Arrow | Show next step in [Appear][] component
Option + P | Toggle [Presenter Mode](#presenter-mode)
Option + O | Toggle [Overview Mode](#overview-mode)
Option + G | Toggle grid view mode
[Appear]: docs/components.md#appear
## Exporting
Add a `build` script to your `package.json` to export a presentation as HTML with a JS bundle.

2
docs/components.md
View File

@ -38,7 +38,7 @@ import { Image } from 'mdx-deck'
## Appear
Use the `<Appear />` component to make its children appear one at a time within a single slide.
Use the up and down arrow keys to step through each element.
Use the left and right arrow keys to step through each element.
```mdx
import { Appear } from 'mdx-deck'