mirror of https://github.com/CrimsonTome/tldr.git
4e53530691
* feat/scripts: support generating PDFs for platform Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * render.py: reformat code for black Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * PDF/README: update command Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * render.py: update code Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * render.py: drop platform none parameter from main Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> |
||
|---|---|---|
| .. | ||
| NotoSans-Regular.ttf | ||
| README.md | ||
| basic.css | ||
| build-pdf.sh | ||
| render.py | ||
| requirements.txt | ||
| solarized-dark.css | ||
| solarized-light.css | ||
README.md
This directory contains the script and related resources to generate a PDF document with all the tldr pages.
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>] [--output <filename>] [--platform <platform-name>]
Complete information about the arguments can be viewed by running:
python3 render.py --help
Available color schemes:
basicsolarized-lightsolarized-dark
Preview
