1
1
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-12-01 21:42:08 +03:00
mdx-deck/docs/index.mdx

78 lines
1.1 KiB
Plaintext
Raw Normal View History

2018-08-04 23:37:23 +03:00
export { future as theme } from '../themes'
2018-08-04 18:31:08 +03:00
import { Image, Notes, Appear } from '../dist'
2018-07-30 00:09:25 +03:00
import Layout from './Layout'
2018-07-29 20:18:00 +03:00
2018-07-29 19:11:24 +03:00
# mdx-deck
MDX-based presention decks
2018-07-28 21:21:36 +03:00
---
2018-07-29 19:11:24 +03:00
# Presentation decks
2018-07-28 21:21:36 +03:00
---
# Built with [MDX][]
[MDX]: https://github.com/mdx-js/mdx
---
import Box from 'superbox'
2018-07-28 21:21:36 +03:00
2018-07-29 19:11:24 +03:00
<Box
2018-07-31 01:04:47 +03:00
fontSize={3}
2018-07-29 19:11:24 +03:00
p={4}
bg='magenta'>
Import React components
2018-07-28 21:21:36 +03:00
</Box>
2018-07-29 18:12:33 +03:00
---
2018-07-29 19:11:24 +03:00
- Make bulleted lists
- To help make your point
2018-08-01 19:22:35 +03:00
---
2018-08-04 23:37:23 +03:00
### Appear
<ul>
<Appear>
<li>One</li>
<li>Two</li>
<li>Three</li>
<li>Four</li>
</Appear>
</ul>
2018-07-29 18:12:33 +03:00
---
2018-07-29 19:11:24 +03:00
## Getting Started
1. `npm i -D mdx-deck`
2018-07-29 18:12:33 +03:00
2. Write some markdown and JSX
3. Present
2018-07-29 19:11:24 +03:00
2018-07-29 18:12:33 +03:00
---
2018-08-03 04:21:16 +03:00
2018-07-29 18:12:33 +03:00
```
<button>code example</button>
```
2018-08-03 03:54:21 +03:00
2018-08-03 05:15:33 +03:00
```notes
- These are speaker notes
- And they won't rendered in your slide
```
2018-08-03 03:54:21 +03:00
2018-07-29 18:12:33 +03:00
---
> “Blockquotes are essential to any good presentation”
Anonymous
2018-07-29 23:17:23 +03:00
2018-08-03 05:15:33 +03:00
<Notes>
<ul>
<li>Speaker notes can also be</li>
<li>Written in JSX</li>
</ul>
</Notes>
2018-08-01 02:27:52 +03:00
---
<Image src='https://images.unsplash.com/photo-1462331940025-496dfbfc7564?w=2048&q=20' />
2018-07-29 18:12:33 +03:00
---
2018-07-30 00:09:25 +03:00
export default Layout
2018-07-29 23:17:23 +03:00
2018-08-01 01:24:46 +03:00
# Get started :sunglasses:
2018-07-29 23:17:23 +03:00
[GitHub](https://github.com/jxnblk/mdx-deck)