Render PDF copies of tldr pages (#1964)
This commit is contained in:

committed by
Agniva De Sarker

parent
930cfe7f89
commit
490da5763d
48
scripts/pdf/README.md
Normal file
48
scripts/pdf/README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# pdf
|
||||
|
||||
This directory contains the script and related resources to generate a PDF copy of tldr pages.
|
||||
|
||||
## Preview
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## 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](http://weasyprint.readthedocs.io/en/latest/install.html).
|
||||
|
||||
## 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`
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user