# gatsby-theme-mdx-deck

> Add MDX Deck presentations to any Gatsby site

Latest version **4.1.0** (published 2020-02-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-theme-mdx-deck
pnpm add gatsby-theme-mdx-deck
yarn add gatsby-theme-mdx-deck
bun add gatsby-theme-mdx-deck
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.0 |
| Published | 2020-02-21 |
| First published | 2019-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 24 |
| Unpacked size | 40.4 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | jxnblk |

## Links

- npm: https://www.npmjs.com/package/gatsby-theme-mdx-deck
- npm.io page: https://npm.io/package/gatsby-theme-mdx-deck

## Dependencies (24)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [gatsby](https://npm.io/package/gatsby.md) ^2.13.24
- [hhmmss](https://npm.io/package/hhmmss.md) ^1.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.3
- [theme-ui](https://npm.io/package/theme-ui.md) ^0.3.1
- [lodash.get](https://npm.io/package/lodash.get.md) ^4.4.2
- [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^1.0.21
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.1
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.0.0-beta
- [remark-emoji](https://npm.io/package/remark-emoji.md) ^2.0.2
- [@emotion/core](https://npm.io/package/@emotion/core.md) ^10.0.14
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.0.21
- [@reach/router](https://npm.io/package/@reach/router.md) ^1.2.1
- [react-swipeable](https://npm.io/package/react-swipeable.md) ^5.3.0
- [@mdx-deck/themes](https://npm.io/package/@mdx-deck/themes.md) ^4.1.0
- [gatsby-plugin-mdx](https://npm.io/package/gatsby-plugin-mdx.md) ^1.0.13
- [remark-unwrap-images](https://npm.io/package/remark-unwrap-images.md) ^1.0.0
- [gatsby-plugin-emotion](https://npm.io/package/gatsby-plugin-emotion.md) ^4.1.0
- [gatsby-plugin-theme-ui](https://npm.io/package/gatsby-plugin-theme-ui.md) ^0.3.0
- [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.1.3
- [gatsby-plugin-catch-links](https://npm.io/package/gatsby-plugin-catch-links.md) ^2.1.0
- [gatsby-remark-import-code](https://npm.io/package/gatsby-remark-import-code.md) ^0.1.1
- [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^3.1.0
- [gatsby-plugin-compile-es6-packages](https://npm.io/package/gatsby-plugin-compile-es6-packages.md) ^2.0.0

## Recent versions

- 4.1.0 (latest) — 2020-02-21
- 4.0.0-alpha.1 (next) — 2020-02-02
- 4.0.0 — 2020-02-12
- 3.1.0 — 2020-02-01
- 3.0.13 — 2019-09-23
- 3.0.11 — 2019-09-10
- 3.0.10 — 2019-09-05
- 3.0.9 — 2019-08-05
- 3.0.8 — 2019-07-28
- 3.0.8-alpha.2 — 2019-07-28
- 3.0.8-alpha.0 — 2019-07-28
- 3.0.7 — 2019-07-19
- 3.0.6 — 2019-07-19
- 3.0.3 — 2019-07-18
- 3.0.1 — 2019-07-18
- … 2 more at https://npm.io/package/gatsby-theme-mdx-deck/versions

## README

# gatsby-theme-mdx-deck

Add MDX Deck presentations to any Gatsby site

```sh
npm i gatsby-theme-mdx-deck
```

```js
// gatsby-config.js
module.exports = {
  plugins: [
    'gatsby-theme-mdx-deck',
  ]
}
```

Add one or more MDX presentation files to the `decks/` directory.
The filenames will be used for creating routes to each deck.

Example `decks/hello.mdx`

```mdx
# Hello!

---

## Beep boop
```

## Layouts

Individual slides can be wrapped with layout components,
which work similarly to slide templates found in other presentation software.

Example `decks/hello.mdx`

```mdx
import Layout from './my-layout'

<Layout>

# Hello

</Layout>

---

## Beep boop
```

## Configuration Options

The Gatsby theme accepts the following options.

```js
// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: 'gatsby-theme-mdx-deck',
      options: {
        // enable or disable gatsby-plugin-mdx
        mdx: false,
        // source directory
        contentPath: 'decks',
        // base path for routes generate by this theme
        basePath: ''
      }
    }
  ]
}
```

MIT License

---
_Source: https://npm.io/package/gatsby-theme-mdx-deck · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._