Domovská stránka Prehľadávať Pomoc
Registrovať Prihlásiť sa
david
/
tldr
zrkadlo https://github.com/tldr-pages/tldr.git
1
0
Fork 0
Súbory Issues 0 Wiki
Strom: 395a96298b
Branche Tagy
tldr
/
scripts
/
pdf
Tristan Jahnke e747bd8132 scripts/*.py: update coding style (#10761) 1 rok pred
..
README.md 896555f79e Updated the render.py README. 4 rokov pred
basic.css ffcd73854c scripts: improve generated PDF bookmark layout (#8809) 2 rokov pred
pt-serif-web-regular.ttf e2ae506613 Rework PDF script (#3654) 5 rokov pred
render.py e747bd8132 scripts/*.py: update coding style (#10761) 1 rok pred
requirements.txt e2ae506613 Rework PDF script (#3654) 5 rokov pred
solarized-dark.css 6637acf662 scripts: add SPDX-License-Identifier in files (#6215) 3 rokov pred
solarized-light.css 6637acf662 scripts: add SPDX-License-Identifier in files (#6215) 3 rokov pred

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