lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-03-28 21:16:20 +01:00
Code Activity
tldr/scripts/pdf
History
Kyle Anthony Williams 954ceb7b98 Made render.py more Pythonic. 
* Converted the top comment to a multi-line string.
* Replaced `i` with `enumerate`.
* Gave the `ArgumentParser` a name and description.
* Added `basic` as a color choice and made it the default.
* Added `color` as a long flag.
* Removed no longer used variables and `if` statement.
2020-12-04 11:58:27 -05:00
..
basic.css Rework PDF script (#3654) 2019-12-17 21:25:52 +01:00
pt-serif-web-regular.ttf Rework PDF script (#3654) 2019-12-17 21:25:52 +01:00
README.md Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) 2020-05-27 22:22:32 +02:00
render.py Made render.py more Pythonic. 2020-12-04 11:58:27 -05:00
requirements.txt Rework PDF script (#3654) 2019-12-17 21:25:52 +01:00
solarized-dark.css Rework PDF script (#3654) 2019-12-17 21:25:52 +01:00
solarized-light.css Rework PDF script (#3654) 2019-12-17 21:25:52 +01:00

README.md

pdf

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

Preview

aa bb cc

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