ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tldr/scripts/pdf
History
Lucas Gabriel Schneider 8b80cf08b8
change markdown to Markdown (#5049) 		2020-12-29 19:45:05 +08:00
..
README.md change markdown to Markdown (#5049) 2020-12-29 19:45:05 +08:00
basic.css pdf script: format & add datetime (#4993) 2020-12-11 20:25:11 +00:00
pt-serif-web-regular.ttf Rework PDF script (#3654) 2019-12-17 21:25:52 +01:00
render.py pdf script: format & add datetime (#4993) 2020-12-11 20:25:11 +00: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