mirror of https://github.com/CrimsonTome/tldr.git
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# pdf
|
|
|
|
This directory contains the script and related resources to generate a PDF document with all the `tldr` pages.
|
|
|
|
## Highlights
|
|
|
|
- No LaTeX dependencies for generating the PDF.
|
|
- 3 available color-schemes: *Basic*, *Solarized Light* and *Solarized Dark*. More can be added easily through CSS.
|
|
|
|
## Requirements
|
|
|
|
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:
|
|
|
|
```sh
|
|
python3 -m pip install -r requirements.txt
|
|
```
|
|
|
|
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:
|
|
|
|
```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:
|
|
|
|
```sh
|
|
python3 render.py --help
|
|
```
|
|
|
|
Available color schemes:
|
|
|
|
- `basic`
|
|
- `solarized-light`
|
|
- `solarized-dark`
|
|
|
|
## Preview
|
|
|
|
|
|
|
|
|