jxnblk/mdx-deck
1
1
Fork 0
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-11-26 00:35:02 +03:00
Code Issues Projects Releases Wiki Activity
afff4997b7
mdx-deck/docs/exporting.md
Brent Jackson 4fc8b25924 Update docs
2019-03-09 22:27:03 -05:00

843 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 & Screenshots

To export a deck as PDF or create a PNG screenshot, install the export CLI package:

npm i @mdx-deck/export

Then run the following command to create a PDF:

mdx-deck-export pdf deck.mdx

Or export the first slide as a PNG:

mdx-deck-export png 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>