mirror of
https://github.com/jxnblk/mdx-deck.git
synced 2024-09-11 06:35:24 +03:00
Edit readme
This commit is contained in:
parent
dad56aefd8
commit
3f89793e89
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user