mdx-deck/docs/theming.md

Theming

mdx-deck uses styled-components for styling, making practically any part of the presentation themeable.

Built-in Themes

mdx-deck includes several built-in themes to change the look and feel of the presentation. Export theme from your MDX file to enable a theme.

export { dark as theme } from 'mdx-deck/themes'

# Dark Theme

For a list of available themes see the Themes Docs.

Custom Themes

A custom theme can be provided by exporting theme from the MDX file.

export { default as theme } from './theme'

# Hello

The theme should be an object with fields for fonts, colors, and CSS for individual components. It's recommended that all custom themes extend the default theme as a base.

import { theme } from 'mdx-deck/themes'

export default {
  // extends the default theme
  ...theme,
  // add a custom font
  font: 'Roboto, sans-serif',
  // custom colors
  colors: {
    text: '#f0f',
    background: 'black',
    link: '#0ff',
  }
}

Google Fonts

To use webfonts, mdx-deck will attempt to add <link> tags for any font from Google Fonts. To load webfonts from other sources, use a custom Provider component to add custom <link> tags.

Syntax Highlighting

By default fenced code blocks do not include any syntax highlighting. Syntax highlighting in fenced code blocks can be enabled by providing a prism style object in a theme. The syntax highlighting is built with react-syntax-highlighter and PrismJS. Create a theme.js file and export it via the MDX file.

export { default as theme } from './theme'
//...

// example theme.js
import { future } from 'mdx-deck/themes'
import okaidia from 'react-syntax-highlighter/styles/prism/okaidia'

export default {
  ...future,
  prism: {
    style: okaidia
  }
}

By default, only JavaScript and JSX are enabled for syntax highlighting to keep bundle sizes to a minimum. To enable other languages, add a languages object to the prism object in the theme.

// example theme.js
import { future } from 'mdx-deck/themes'
import okaidia from 'react-syntax-highlighter/styles/prism/okaidia'
import prismRuby from 'react-syntax-highlighter/languages/prism/ruby'

export default {
  ...future,
  prism: {
    style: okaidia,
    languages: {
      ruby: prismRuby
    }
  }
}

To see available syntax styles and languages, see:

• Prism languages
• Prism styles

Styling Elements

Each element can be styled with a theme. Add a style object (or string) to the theme to target specific elements.

// example theme
import { theme } from 'mdx-deck/themes'

export default {
  ...theme,
  h1: {
    textTransform: 'uppercase',
    letterSpacing: '0.1em'
  },
  blockquote: {
    fontStyle: 'italic'
  }
}

See the reference below for a full list of element keys.

Custom MDX Components

mdx-deck includes default components for MDX, but to provide custom components to the MDXProvider, add a components object to the `theme.

// example theme
import { theme } from 'mdx-deck/themes'
import components from './components'

export default {
  ...theme,
  components
}

See the MDX docs for more or take a look

Provider component

A custom Provider component can be exported to wrap the entire application. This is useful for adding custom context providers in React.

export { default as Provider } from './Provider'

# Hello

A custom Provider component will receive the application's state as props, which can be used to show custom page numbers or add other elements to the UI.

Props

• index: (number) the current slide index
• length: (number) the length of the slides array
• mode: (string) the current mode (one of 'NORMAL' or 'PRESENTER')
• notes: (object) custom speaker notes for all slides

Reference

The following keys are available for theming:

• font: base font family
• weights: array of font weights for the main font
• monospace: font family for <pre> and <code>
• fontSizes: array of font sizes from smallest to largest
• colors: object of colors used for MDX components
  • text: root foreground color
  • background: root background color
  • link
  • heading
  • blockquote
  • pre
  • preBackground
  • code
  • codeBackground
• css: root CSS object
• heading: CSS for all headings
• h1: CSS for <h1>
• h2: CSS for <h2>
• h3: CSS for <h3>
• paragraph: CSS for <p>
• link: CSS for <a>
• ul: CSS for <ul>
• ol: CSS for <ol>
• li: CSS for <li>
• img: CSS for <img>
• table: CSS for <table>
• components: object of MDX components to render markdown
• Provider: component for wrapping the entire app