# @mdx-deck/gatsby-theme

> **WIP** A Gatsby theme for adding MDX Decks to your Gatsby site

Latest version **2.5.0** (published 2019-07-07) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.5.0 |
| Published | 2019-07-07 |
| First published | 2019-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Brent Jackson |
| Maintainers | jxnblk |

## Links

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

## Dependencies (13)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.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.1
- [remark-emoji](https://npm.io/package/remark-emoji.md) ^2.0.2
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.0.1
- [@mdx-deck/themes](https://npm.io/package/@mdx-deck/themes.md) ^2.5.0
- [gatsby-plugin-mdx](https://npm.io/package/gatsby-plugin-mdx.md) ^1.0.6
- [@mdx-deck/components](https://npm.io/package/@mdx-deck/components.md) ^2.5.0
- [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.0.6
- [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.0.29
- [gatsby-plugin-compile-es6-packages](https://npm.io/package/gatsby-plugin-compile-es6-packages.md) ^1.1.0

## Recent versions

- 2.5.0 (latest) — 2019-07-07
- 2.1.2-alpha.0 (next) — 2019-04-12
- 2.4.0 — 2019-06-19
- 2.3.2 — 2019-04-22
- 2.3.1 — 2019-04-21
- 2.3.0 — 2019-04-20
- 2.2.3 — 2019-04-20
- 2.2.2 — 2019-04-20
- 2.2.1 — 2019-04-15
- 2.2.0 — 2019-04-13
- 2.1.4 — 2019-04-12
- 2.1.3 — 2019-04-12
- 2.1.2 — 2019-04-12
- 2.1.1 — 2019-04-12
- 2.1.0 — 2019-04-12
- … 7 more at https://npm.io/package/@mdx-deck/gatsby-theme/versions

## README

# @mdx-deck/gatsby-theme

**WIP** A Gatsby theme for adding MDX Decks to your Gatsby site

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

_Note:_ This theme **requires MDX v1** and will not work with previous versions of MDX

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

Add MDX Decks to the `src/decks/` directory. The filename will be used for the route of that deck.

**/src/decks/hello.mdx**

```mdx
# Hello!

---

## Beep
```

## Using Layouts

Slide layout components must be rendered inline, _not_ using the default export syntax.

**/src/decks/hello.mdx**

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

<Layout>

# Hello Layout

</Layout>
```

## Theme Config

The following options can be passed to the gatsby theme.

```js
// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: '@mdx-deck/gatsby-theme',
      options: {
        // disable gatsby-mdx plugin – use this when your site already uses gatsby-mdx
        mdx: false,
        // source directory for decks
        path: 'src/presentations',
        // name routes' basepath
        name: 'presentations',
      },
    },
  ],
}
```

MIT License

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