Mdx-deck: MDX Deck v3

Created on 29 Jun 2019  路  4Comments  路  Source: jxnblk/mdx-deck

I haven't had as much time to work on MDX Deck lately, so I wanted to document some of the upcoming changes I'd like to introduce in the next major version. A rough prototype was started on the next branch for reference.

The high-level proposed changes are:

  • Replace the core MDX Deck CLI with Gatsby
  • Use @mdx-deck/gatsby-theme as the core part of the app
  • Render each slide as static HTML (currently slides are client-side rendered)
  • Enable shadowing of the core UI components (Provider, presenter view, etc)
  • Allow any relevant Gatsby plugin to work with MDX Deck
  • Replace custom theming setup with Theme UI
  • Deprecate the use of default exports for layouts in favor of the approach here: #326
  • The end-user API for authoring decks should be mostly backwards-compatible

I'm opening this issue to allow for discussion, and to gauge interest if anyone would like to help contribute to working towards the next major version of MDX Deck.

3.0 discussion help wanted

All 4 comments

That all sounds awesome :) I got @mdx-deck/gatsby-theme running today on a new Gatsby site with MDX, and the biggest changes it needed were an upgrade to gatsby-plugin-mdx and the experimentalThemes API going away. Another thing I noticed about the docs was as someone new to MDX, it would help to list filenames and extensions in code snippets like we do on the Gatsby docs. But I'm super stoked to have a slide deck as part of a site, and it was worth figuring out the setup. Love your idea about rendering static HTML for slides!

the biggest changes it needed were an upgrade to gatsby-plugin-mdx and the experimentalThemes API going away.

Thanks, good catch! I'll try to get a PR up to update the docs

Another thing I noticed about the docs was as someone new to MDX, it would help to list filenames and extensions in code snippets

Are you referring to the MDX code examples in the README.md and other markdown files?

For the docs thing, it was the examples on the mdx-deck gatsby-theme: https://github.com/jxnblk/mdx-deck/tree/master/packages/gatsby-theme

Hey excited about this and thanks for laying out the plans for an awesome v3 :)
I am wondering how tightly coupled the themes need to be with mdx-deck. I am currently using grommet for a lot of my projects and have been using it for mdx-deck layouts/themes etc.

Currently I am choosing a default theme for mdx-deck but i am not using it much since i wrap each slide with grommet. Would be great if this would still be possible or even if we could optionally avoid pulling in theme-ui or any other theming package!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dance2die picture dance2die  路  5Comments

busypeoples picture busypeoples  路  4Comments

codepunkt picture codepunkt  路  5Comments

Irev-Dev picture Irev-Dev  路  4Comments

kwangkim picture kwangkim  路  4Comments