mdx-deck Template

A basic boilerplate to use with mdx-deck with all components and layouts. Different themes and configurations available as feature branches.

Features

Swap to different themes and configurations by building feature branches (or checkout + merge with production branch).

• ⚫ Dark theme
• 🌈 Syntax Highlighting with Theming

Development

To run the presentation deck in development mode:

npm start

Edit the deck.mdx file to get started.

Exporting

To build the presentation deck as static HTML:

npm run build

To export a PDF:

npm run pdf

To export an image of the title slide:

npm run image

For more documentation see the mdx-deck repo.

Deploy

Netlify

1. Clone the project locally and add to your Github
2. Add the repo to Netlify

or

1. Click deploy to Netlify on the example repo

⚙️ Netlify settings

In order to make sure our deck deploys properly using continuous integration, we have to configure Netlify to build and display our app.

Go to your Deploy Settings (under the Deploys tab in your Netlify project/repo) and add the following settings:

1. Set the build script to npm run build
2. Set the deploy folder to dist

We give Netlify a build script to run each time we make a commit to the repo. And the deploy folder is the place where mdx-deck exports the static HTML/JS version, and by pointing Netlify there it displays our deck after building.

See the demo site here

Credits

• mdx-deck by @jxnblk