Skip to content

Commit

Permalink
docs: no need to set up wkhtmltopdf for local environment
Browse files Browse the repository at this point in the history
Addresses #1043
  • Loading branch information
George Song committed Mar 10, 2021
1 parent bcc27f7 commit d99d574
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,7 @@ We recommend using MacOS to work with the EDB Docs application.

### Installation of PDF / Doc Conversion Tools (optional)

If you need to build PDFs locally, or run parts of the RST to MDX conversion pipeline, you'll need a couple more tools installed.

1. Install `wkhtmltopdf`, a tool that converts html documents to pdf documents. You can install this with `brew install wkhtmltopdf`. Currently we are using version `0.12.6` - you can check the installed version with `wkhtmltopdf -V`. Newer versions are likely to work fine as well.

1. Install `pandoc`, a general purpose document conversion tool. This can also be installed with homebrew - `brew install pandoc`.

1. To confirm that both tools are working, you can trying building a PDF. `yarn build-pdf product_docs/docs/epas/13/` will build `epas_v13_documentation.pdf` in the `epas/13/` folder. You may see a few warnings, but the process should finish with `✨ Done in 43.25s.` or similar.
If you need to run parts of the RST to MDX conversion pipeline, you'll need to install `pandoc`, a general purpose document conversion tool. This can also be installed with homebrew - `brew install pandoc`.

## Windows Installation

Expand Down

0 comments on commit d99d574

Please sign in to comment.