Home Explore Help
Register Sign In
david
/
tldr
mirror of https://github.com/tldr-pages/tldr.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: fb5a970497
Branches Tags
tldr
/
scripts
/
pdf
Tristan Jahnke e747bd8132 scripts/*.py: update coding style (#10761) 1 year ago
..
README.md 896555f79e Updated the render.py README. 4 years ago
basic.css ffcd73854c scripts: improve generated PDF bookmark layout (#8809) 2 years ago
pt-serif-web-regular.ttf e2ae506613 Rework PDF script (#3654) 5 years ago
render.py e747bd8132 scripts/*.py: update coding style (#10761) 1 year ago
requirements.txt e2ae506613 Rework PDF script (#3654) 5 years ago
solarized-dark.css 6637acf662 scripts: add SPDX-License-Identifier in files (#6215) 3 years ago
solarized-light.css 6637acf662 scripts: add SPDX-License-Identifier in files (#6215) 3 years ago

README.md

pdf

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

Preview

cryptsetup in the Basic color-scheme. cryptsetup in the Solarized Light color-scheme. cryptsetup in the Solarized Dark color-scheme.

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