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

Edit readme

Browse Source
This commit is contained in:
Brent Jackson 2018-07-29 12:21:37 -04:00
parent dad56aefd8
commit 3f89793e89
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -9,6 +9,8 @@
npm i mdx-deck
```
Create an [MDX][] file and separate each slide with `---`.
````mdx
# This is the title of my deck
---
@ -25,13 +27,14 @@ import Demo from './components/Demo'
# The end
````
Run the CLI pointing to the `.mdx` file to start the dev server:
```sh
mdx-deck deck.mdx
```
## Usage
Create an [MDX][] file and separate each slide with `---`.
MDX can use Markdown syntax and render React components with JSX.
### Imports