mirror of https://github.com/CrimsonTome/tldr.git
a2ab577848
* scrips: build and deploy PDF pages for all languages * cleanup/render.py: reformat code Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * Apply suggestions from code review Co-authored-by: Matthew Peveler <matt.peveler@gmail.com> * scrpts/pdf: update README, refactor code Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * test/ci: building PDF was wildcard Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * test/ci: building translations as wildcard 2 * test/ci: fix flag in PDF building Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * test/ci: update build pdf action Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * test/ci: extend PDF exclusion list Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * cleanup/ci: update PDF translation build Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * scripts/pdf: add website and repo link Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * test/ci: move PDF build to seperate script file Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * test/ci: minor fixes to build pdf script Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * cleanup/ci: update build PDF Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * scripts: update font family, minor fix Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * fix/deploy: sha256sum command Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: Matthew Peveler <matt.peveler@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>]
Complete information about the arguments can be viewed by running:
python3 render.py --help
Available color schemes:
basicsolarized-lightsolarized-dark
Preview
