mirror of
https://github.com/jxnblk/mdx-deck.git
synced 2024-11-29 13:58:02 +03:00
Add docs
This commit is contained in:
parent
d6ed8bbd70
commit
99ed83c187
29
docs/api.md
29
docs/api.md
@ -2,6 +2,35 @@
|
||||
|
||||
MDX Deck consists of several different packages. The core `mdx-deck` package includes the CLI, `@mdx-deck/components`,
|
||||
|
||||
## Components
|
||||
|
||||
See the [components docs](components.md) for details.
|
||||
|
||||
- `MDXDeck`
|
||||
- `MDXDeckState`
|
||||
- `Head`
|
||||
- `Image`
|
||||
- `Notes`
|
||||
- `Steps`
|
||||
- `Appear`
|
||||
- `Slide`
|
||||
- `Zoom`
|
||||
- `Embed`
|
||||
|
||||
## Layouts
|
||||
|
||||
See the [layouts docs](layouts.md) for details.
|
||||
|
||||
- `Invert`
|
||||
- `Split`
|
||||
- `SplitRight`
|
||||
- `FullScreenCode`
|
||||
- `Horizontal`
|
||||
|
||||
## Themes
|
||||
|
||||
See the [themes](themes.md) & [theming](theming.md) docs for details.
|
||||
|
||||
## Context
|
||||
|
||||
MDX Deck uses a stateful React context for each slide.
|
||||
|
@ -7,10 +7,12 @@ export { Appear } from './Appear'
|
||||
export { withContext, useDeck } from './context'
|
||||
export { default as useSteps } from './useSteps'
|
||||
|
||||
export { Provider } from './Provider'
|
||||
export { Slide } from './Slide'
|
||||
export { Zoom } from './Zoom'
|
||||
|
||||
export { Embed } from './Embed'
|
||||
export { Ratio } from './Ratio'
|
||||
|
||||
// private
|
||||
export { splitSlides } from './splitSlides'
|
||||
export { Ratio } from './Ratio'
|
||||
export { Provider } from './Provider'
|
||||
|
@ -294,6 +294,7 @@ See more exporting options in the [Exporting Documentation](docs/exporting.md)
|
||||
- [Components](docs/components.md)
|
||||
- [Exporting](docs/exporting.md)
|
||||
- [Advanced Usage](docs/advanced.md)
|
||||
- [API](docs/api.md)
|
||||
|
||||
## Examples
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user