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

Merge pull request #327 from jxnblk/update-readme

Browse Source 
Update readme
This commit is contained in:
Brent Jackson 2019-04-13 13:24:18 -04:00 committed by GitHub
commit 9ed28072d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
packages/mdx-deck/README.md
View File

@ -1,8 +1,8 @@
# MDX Deck # MDX Deck
![](https://s3.amazonaws.com/jxnblk/mdx-deck.gif) ![](https://s3.amazonaws.com/jxnblk/mdx-deck-2.gif)
[MDX][]-based presentation decks Award-winning [MDX][]-based presentation decks
[![Build Status][badge]][travis] [![Build Status][badge]][travis]
[![Version][]][npm] [![Version][]][npm]
@ -11,7 +11,7 @@
[badge]: https://flat.badgen.net/travis/jxnblk/mdx-deck [badge]: https://flat.badgen.net/travis/jxnblk/mdx-deck
[travis]: https://travis-ci.org/jxnblk/mdx-deck [travis]: https://travis-ci.org/jxnblk/mdx-deck
[version]: https://flat.badgen.net/npm/v/mdx-deck [version]: https://flat.badgen.net/npm/v/mdx-deck
[downloads]: https://flat.badgen.net/npm/dw/mdx-deck [downloads]: https://flat.badgen.net/npm/dm/mdx-deck
[npm]: https://npmjs.com/package/mdx-deck [npm]: https://npmjs.com/package/mdx-deck
```sh ```sh
@ -86,14 +86,6 @@ npm start
[ks-egghead]: https://egghead.io/lessons/javascript-build-a-custom-provider-component-for-mdx-deck [ks-egghead]: https://egghead.io/lessons/javascript-build-a-custom-provider-component-for-mdx-deck
[kyle shevlin]: https://twitter.com/kyleshevlin [kyle shevlin]: https://twitter.com/kyleshevlin
## Quick Start
To create a new presentation with zero-configuration, run the following command to generate a presentation deck in a new folder:
```sh
npm init deck my-presentation-name
```
## Using MDX ## Using MDX
MDX can use Markdown syntax and render React components with JSX. MDX can use Markdown syntax and render React components with JSX.
@ -233,7 +225,7 @@ MDX Deck includes a built-in _Presenter Mode_, with a preview of the next slide
To use presenter mode: To use presenter mode:
1. Open your presentation and enter _Presenter Mode_ 1. Open your presentation and press `Option + P` to enter _Presenter Mode_
2. Click on the link in the bottom to open the presentation in another tab 2. Click on the link in the bottom to open the presentation in another tab
3. Move the other window to the screen for the audience to see 3. Move the other window to the screen for the audience to see
4. Control the presentation from your window using the left and right arrow keys – the other window should stay in sync 4. Control the presentation from your window using the left and right arrow keys – the other window should stay in sync
@ -269,10 +261,6 @@ This shows a list of all slides on the left and a preview of the current slide o
| Option + P | Toggle [Presenter Mode](#presenter-mode) | | Option + P | Toggle [Presenter Mode](#presenter-mode) |
| Option + O | Toggle [Overview Mode](#overview-mode) | | Option + O | Toggle [Overview Mode](#overview-mode) |
### URL Query String
The alternative modes in MDX Deck can also be set with query strings: `?mode=presenter` or `?mode=overview`
[appear]: docs/components.md#appear [appear]: docs/components.md#appear
## Exporting ## Exporting