jxnblk/mdx-deck
1
1
Fork 0
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-09-20 19:37:27 +03:00
Code Issues Projects Releases Wiki Activity
bc7a9e2153
mdx-deck/docs/exporting.md
Brent Jackson 486eafd9b1 Edit docs
2018-08-14 20:59:58 -04:00

991 B
Raw Blame History

Exporting

Static Bundle

To export your deck as a static HTML page with JS bundle, add a build script to your package.json file.

"scripts": {
  "build": "mdx-deck build deck.mdx"
}

PDF Export

Presentations can be exported as PDF using the CLI. This works well as a backup option for any unforeseen technical difficulties.

"script": {
  "pdf": "mdx-deck pdf deck.mdx"
}

Screenshots

A PNG image of the first slide can be exported with the screenshot command. This is useful for creating open graph images for Twitter, Facebook, or Slack.

"script": {
  "screenshot": "mdx-deck screenshot deck.mdx"
}

OG Image

To use the image as an open graph image, use the Head component to add a meta tag. Note that the meta tag should point to a full URL, including schema and domain name.

import { Head } from 'mdx-deck'

<Head>
  <meta name='og:image' content='https://example.com/card.png' />
</Head>