tldr/scripts/pdf/README.md

# pdf

This directory contains the script and related resources to generate a PDF document with all the `tldr` pages.

## Preview

![cryptsetup in the Basic color-scheme.](https://user-images.githubusercontent.com/29029116/35637791-4e42af80-06db-11e8-8b8e-42ce6c905ff4.jpg)
![cryptsetup in the Solarized Light color-scheme.](https://user-images.githubusercontent.com/29029116/35637798-51e3784a-06db-11e8-9576-6e57ef5c5c20.jpg)
![cryptsetup in the Solarized Dark color-scheme.](https://user-images.githubusercontent.com/29029116/35637801-54449fce-06db-11e8-93f7-d90cdc34044b.jpg)

## 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](http://weasyprint.readthedocs.io/en/latest/install.html).

## Usage

Generating the PDF is as simple as running:

    python3 render.py <path-to-pages-directory> --color <color-scheme>

Complete information about the arguments can be viewed by running:

    python3 render.py --help

The color-schemes that can be specified are:

* `basic`
* `solarized-light`
* `solarized-dark`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00			`# pdf`

Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) 2020-05-11 00:23:54 +01:00			This directory contains the script and related resources to generate a PDF document with all the `tldr` pages.
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
			`## Preview`

Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			`![cryptsetup in the Basic color-scheme.](https://user-images.githubusercontent.com/29029116/35637791-4e42af80-06db-11e8-8b8e-42ce6c905ff4.jpg)`
			`![cryptsetup in the Solarized Light color-scheme.](https://user-images.githubusercontent.com/29029116/35637798-51e3784a-06db-11e8-9576-6e57ef5c5c20.jpg)`
			`![cryptsetup in the Solarized Dark color-scheme.](https://user-images.githubusercontent.com/29029116/35637801-54449fce-06db-11e8-93f7-d90cdc34044b.jpg)`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
			`## Highlights`

			`- No LaTeX dependencies for generating the PDF.`
Rework PDF script (#3654) 2019-12-17 20:25:52 +00:00			`- 3 available color-schemes: Basic, Solarized Light and Solarized Dark. More can be added easily through CSS.`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
			`## Requirements`

Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			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:
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			`python3 -m pip install -r requirements.txt`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
			`Make sure OS specific dependencies for WeasyPrint are installed by following the instructions [here](http://weasyprint.readthedocs.io/en/latest/install.html).`

			`## Usage`

Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			`Generating the PDF is as simple as running:`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			`python3 render.py <path-to-pages-directory> --color <color-scheme>`
Rework PDF script (#3654) 2019-12-17 20:25:52 +00:00
Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			`Complete information about the arguments can be viewed by running:`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
			`python3 render.py --help`

Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			`The color-schemes that can be specified are:`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00
Updated the render.py README. * Updated command line usage to: * Reflect changes made to the CLI. * Demonstrate recommended use of pip. * Made some grammar changes. * Added more useful alt text to the images. 2020-12-04 17:09:48 +00:00			* `basic`
Render PDF copies of tldr pages (#1964) 2018-03-11 18:53:48 +00:00			* `solarized-light`
			* `solarized-dark`