ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tldr/scripts/pdf/README.md

1.3 KiB
Raw Blame History

pdf

This directory contains the script and related resources to generate a PDF copy of 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 the following libraries:

Python-Markdown

pip3 install markdown

WeasyPrint

pip3 install WeasyPrint

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