History

dependabot[bot] d06d41d23a build(deps): bump black from 22.3.0 to 23.3.0, reformat render.py for latest black version (#10284 ) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>		2023-06-13 15:18:54 +02:00
..
README.md	Updated the render.py README.	2020-12-04 12:09:48 -05:00
basic.css	scripts: improve generated PDF bookmark layout (#8809 )	2022-10-07 20:10:44 -03:00
pt-serif-web-regular.ttf	Rework PDF script (#3654 )	2019-12-17 21:25:52 +01:00
render.py	build(deps): bump black from 22.3.0 to 23.3.0, reformat render.py for latest black version (#10284 )	2023-06-13 15:18:54 +02:00
requirements.txt	Rework PDF script (#3654 )	2019-12-17 21:25:52 +01:00
solarized-dark.css	scripts: add SPDX-License-Identifier in files (#6215 )	2021-07-16 14:15:31 +01:00
solarized-light.css	scripts: add SPDX-License-Identifier in files (#6215 )	2021-07-16 14:15:31 +01:00

README.md

pdf

This directory contains the script and related resources to generate a PDF document with all the tldr pages.

Preview

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:

python3 -m pip install -r requirements.txt

Make sure OS specific dependencies for WeasyPrint are installed by following the instructions here.

Usage

Generating the PDF is as simple as running:

python3 render.py <path-to-pages-directory> --color <color-scheme>

Complete information about the arguments can be viewed by running:

python3 render.py --help

The color-schemes that can be specified are:

basic
solarized-light
solarized-dark