Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added DeckTape Docker printing instructions to README #345

Merged
merged 2 commits into from
Oct 16, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,20 @@ In case of an error, please try the following:
- Analyze debug output, e.g. `DEBUG=reveal-md reveal-md slides.md --print`
- See `reveal-md help` for Puppeteer arguments (`puppeteer-launch-args` and `puppeteer-chromium-executable`)

### Printing with DeckTape

The default method of printing does not currently work when running reveal-md in a Docker container, so it is recommended that you print with [DeckTape](https://github.com/astefanutti/decktape) instead, which also has a Docker container and an npm-installable version. Using DeckTape may also resolve issues if you have a problem with the built-in printing method’s output.

To create a PDF of a presentation from reveal-md instance running on localhost on the default port 1948 using the DeckTape Docker image, use the following command, where `$OUTPUT_DIR` is the folder you want the PDF to be saved to, `$PRESENTATION_URL` is the URL at which the presentation can be accessed in your browser (without the `?print-pdf` suffix), and `$OUTPUT_FILENAME` is the name of the PDF:

```bash
$ docker run --rm -t --net=host -v $OUTPUT_DIR:/slides astefanutti/decktape $PRESENTATION_URL $OUTPUT_FILENAME
```

Note: if you are not running reveal-md in Docker, you will need to replace the `localhost` portion of the presentation URL with the IP address of your computer.

For a full list of export options, please see the the [DeckTape github](https://github.com/astefanutti/decktape), or run the Docker container with the `-h` flag.

### Static Website

This will export the provided Markdown file into a stand-alone HTML website including scripts and stylesheets. The files
Expand Down