mirror of https://github.com/CrimsonTome/tldr.git
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.translation-badges
parent
954ceb7b98
commit
896555f79e
|
@ -4,9 +4,9 @@ This directory contains the script and related resources to generate a PDF docum
|
|||
|
||||
## Preview
|
||||
|
||||
![aa](https://user-images.githubusercontent.com/29029116/35637791-4e42af80-06db-11e8-8b8e-42ce6c905ff4.jpg)
|
||||
![bb](https://user-images.githubusercontent.com/29029116/35637798-51e3784a-06db-11e8-9576-6e57ef5c5c20.jpg)
|
||||
![cc](https://user-images.githubusercontent.com/29029116/35637801-54449fce-06db-11e8-93f7-d90cdc34044b.jpg)
|
||||
![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
|
||||
|
||||
|
@ -15,23 +15,24 @@ This directory contains the script and related resources to generate a PDF docum
|
|||
|
||||
## Requirements
|
||||
|
||||
The PDF is generated by first converting the markdown files to HTML, and then rendering those HTML files as PDF. It depends on `markdown` and `weasyprint` libraries. To install the dependencies, run:
|
||||
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:
|
||||
|
||||
pip3 install -r requirements.txt
|
||||
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
|
||||
Generating the PDF is as simple as running:
|
||||
|
||||
python3 render.py <path-to-pages-directory> -c <color-scheme>
|
||||
python3 render.py <path-to-pages-directory> --color <color-scheme>
|
||||
|
||||
Complete information about the arguments can be viewed by running
|
||||
Complete information about the arguments can be viewed by running:
|
||||
|
||||
python3 render.py --help
|
||||
|
||||
The color-schemes that can be specified are
|
||||
The color-schemes that can be specified are:
|
||||
|
||||
* `basic`
|
||||
* `solarized-light`
|
||||
* `solarized-dark`
|
||||
|
|
Loading…
Reference in New Issue