Skip to content

Commit

Permalink
cleanup: update PDF README
Browse files Browse the repository at this point in the history
  • Loading branch information
kbdharun committed Dec 24, 2023
1 parent 5f0fa5d commit e9750a9
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions scripts/pdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,25 @@ This directory contains the script and related resources to generate a PDF docum

The PDF is generated by first converting the Markdown files to HTML, and then rendering those HTML files as a PDF. It depends on the `markdown` and `weasyprint` libraries. To install the dependencies, run:

python3 -m pip install -r requirements.txt
```sh
python3 -m pip install -r requirements.txt
```

Make sure OS specific dependencies for WeasyPrint are installed by following the instructions [here](http://weasyprint.readthedocs.io/en/latest/install.html).
Make sure OS-specific dependencies for WeasyPrint are installed by following the instructions [here](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation).

## Usage

Generating the PDF is as simple as running:

python3 render.py <path-to-pages-directory> [--color <color-scheme>] [--output <filename>] [--platform <platform-name>]
```sh
python3 render.py <path-to-pages-directory> [--color <color-scheme>] [--output <filename>] [--platform <platform-name>]
```

Complete information about the arguments can be viewed by running:

python3 render.py --help
```sh
python3 render.py --help
```

Available color schemes:

Expand Down

0 comments on commit e9750a9

Please sign in to comment.