History

Waldir Pimenta 37634b36f7 Harmonize project name (lowercase tldr, no semicolon, hyphen-separated)		2020-05-27 22:22:32 +02:00
..
README.md	Harmonize project name (lowercase tldr, no semicolon, hyphen-separated)	2020-05-27 22:22:32 +02:00
basic.css	…
pt-serif-web-regular.ttf	…
render.py	Harmonize project name (lowercase tldr, no semicolon, hyphen-separated)	2020-05-27 22:22:32 +02:00
requirements.txt	…
solarized-dark.css	…
solarized-light.css	…

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 PDF. It depends on markdown and weasyprint libraries. To install the dependencies, run:

pip3 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> -c <color-scheme>

Complete information about the arguments can be viewed by running

python3 render.py --help

The color-schemes that can be specified are

solarized-light
solarized-dark