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

45 lines
1.5 KiB
Markdown
Raw Normal View History

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
## 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
cleanup: update PDF README
2023-12-21 17:03:29 +00:00
```sh
python3 -m pip install -r requirements.txt
```
Render PDF copies of tldr pages (#1964)
2018-03-11 18:53:48 +00:00
cleanup: update PDF README
2023-12-21 17:03:29 +00:00
Make sure OS-specific dependencies for WeasyPrint are installed by following the instructions [here](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation).
Render PDF copies of tldr pages (#1964)
2018-03-11 18:53:48 +00:00
## 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
cleanup: update PDF README
2023-12-21 17:03:29 +00:00
```sh
python3 render.py <path-to-pages-directory> [--color <color-scheme>] [--output <filename>] [--platform <platform-name>]
```
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
cleanup: update PDF README
2023-12-21 17:03:29 +00:00
```sh
python3 render.py --help
```
Render PDF copies of tldr pages (#1964)
2018-03-11 18:53:48 +00:00
scripts: build and deploy PDF pages for translations (#10969) * scripts: build and deploy PDF pages for translations Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * render.py: fix typo in filename description --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-21 22:04:22 +01:00
Available color schemes:
Render PDF copies of tldr pages (#1964)
2018-03-11 18:53:48 +00:00
scripts: build and deploy PDF pages for translations (#10969) * scripts: build and deploy PDF pages for translations Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * render.py: fix typo in filename description --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-21 22:04:22 +01:00
- `basic`
- `solarized-light`
- `solarized-dark`
## 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)