diff --git a/docs/api.md b/docs/api.md index 260ec85..5d3705c 100644 --- a/docs/api.md +++ b/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. diff --git a/packages/components/src/index.js b/packages/components/src/index.js index c8fece8..3db55b2 100644 --- a/packages/components/src/index.js +++ b/packages/components/src/index.js @@ -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' diff --git a/packages/mdx-deck/README.md b/packages/mdx-deck/README.md index 3217664..9356d9c 100644 --- a/packages/mdx-deck/README.md +++ b/packages/mdx-deck/README.md @@ -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