K.B.Dharun Krishna b333d3d3a5 Revert "scripts: build and deploy PDF pages for translations (#10846)" (#10965) 1 jaar geleden
..
README.md b333d3d3a5 Revert "scripts: build and deploy PDF pages for translations (#10846)" (#10965) 1 jaar geleden
basic.css b333d3d3a5 Revert "scripts: build and deploy PDF pages for translations (#10846)" (#10965) 1 jaar geleden
pt-serif-web-regular.ttf b333d3d3a5 Revert "scripts: build and deploy PDF pages for translations (#10846)" (#10965) 1 jaar geleden
render.py b333d3d3a5 Revert "scripts: build and deploy PDF pages for translations (#10846)" (#10965) 1 jaar geleden
requirements.txt e2ae506613 Rework PDF script (#3654) 5 jaren geleden
solarized-dark.css 6637acf662 scripts: add SPDX-License-Identifier in files (#6215) 3 jaren geleden
solarized-light.css 6637acf662 scripts: add SPDX-License-Identifier in files (#6215) 3 jaren geleden

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