DawnMagnet/tldr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rework PDF script (#3654)

Browse Source
This commit is contained in:
Zlatan Vasović
2019-12-17 21:25:52 +01:00
committed by GitHub
parent d77f8bc18a
commit e2ae506613
8 changed files with 126 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@@ -14,3 +14,7 @@ npm-debug.log
# hosted at https://tldr-pages.github.io/assets/index.json
pages/index.json
index.json
# Generated PDF pages
scripts/pdf/*.html
scripts/pdf/tldr.pdf

17
scripts/pdf/README.md
View File

@@ -11,21 +11,13 @@ This directory contains the script and related resources to generate a PDF copy
## 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.
- 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:
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:
#### Python-Markdown
pip3 install markdown
#### WeasyPrint
pip3 install WeasyPrint
pip3 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).
@@ -43,6 +35,3 @@ The color-schemes that can be specified are
* `solarized-light`
* `solarized-dark`

14
scripts/pdf/basic.css
View File

@@ -1,6 +1,6 @@
@font-face {
font-family: 'PT_Serif-Web-Regular';
src: url('PT_Serif-Web-Regular.ttf') format('truetype');
font-family: "PT Serif";
src: url("pt-serif-web-regular.ttf") format("truetype");
}
p {
@@ -11,23 +11,23 @@ code {
color: darkslategrey;
}
h1, h4, h2, ul {
font-family: "PT_Serif-Web-Regular";
h1, h2, h4, ul {
font-family: "PT Serif";
}
h1.titlemain {
.title-main {
text-align: center;
margin-top: 6em;
font-size: 350%;
}
h4.titlesub {
.title-sub {
text-align: center;
font-size: 120%;
color: darkslategrey;
}
h2.titledir {
.title-dir {
text-align: center;
margin-top: 8.2em;
font-size: 300%;

0
scripts/pdf/PT_Serif-Web-Regular.ttf → scripts/pdf/pt-serif-web-regular.ttf
View File

57
scripts/pdf/render.py
View File

@@ -1,8 +1,8 @@
#!/usr/bin/env python3
#A Python script to generate a single PDF document with all the tldr pages. It works by generating
#intermediate HTML files from existing md files using Python-markdown, applying desired formatting
#through CSS, and finally rendering them as PDF. There is no LaTeX dependency for generating the PDF.
# A Python script to generate a single PDF document with all the tldr pages. It works by generating
# intermediate HTML files from existing md files using Python-markdown, applying desired formatting
# through CSS, and finally rendering them as PDF. There is no LaTeX dependency for generating the PDF.
import os
import sys
@@ -20,49 +20,52 @@ def main(loc, colorscheme):
group = []
ap = []
#Checking correctness of path
# Checking correctness of path
if not os.path.isdir(loc):
print("Invalid directory. Please try again!", file = sys.stderr)
sys.exit(1)
#Writing names of all directories inside 'pages' to a list
# Writing names of all directories inside 'pages' to a list
for os_dir in os.listdir(loc):
oslist.append(os_dir)
oslist.sort()
#Required strings to create intermediate HTML files
header = "<html><head><link rel=stylesheet type=text/css href=" + colorscheme + ".css></head><body>\n"
# Required strings to create intermediate HTML files
header = '<!doctype html><html><head><meta charset="utf-8"><link rel="stylesheet" href="basic.css">'
if colorscheme != "basic":
header += '<link rel="stylesheet" href="' + colorscheme + '.css"></head><body>\n'
header += "</head><body>\n"
footer = "</body></html>"
title_content = "<h1 class=titlemain>tldr pages</h1><h4 class=titlesub>Simplified and community driven man pages</h4></body></html>"
title_content = "<h1 class=title-main>tldr pages</h1><h4 class=title-sub>Simplified and community-driven man pages</h4></body></html>"
#Creating title page
with open("title.html", 'w') as f:
# Creating title page
with open("title.html", "w") as f:
f.write(header + title_content)
group.append(HTML('title.html').render())
group.append(HTML("title.html").render())
for operating_sys in oslist:
i = 1
#Required string to create directory title pages
dir_title = "<h2 class=titledir>" + operating_sys.capitalize() + "</h2></body></html>"
# Required string to create directory title pages
dir_title = "<h2 class=title-dir>" + operating_sys.capitalize() + "</h2></body></html>"
#Creating directory title page for current directory
with open("dir_title.html", 'w') as os_html:
# Creating directory title page for current directory
with open("dir_title.html", "w") as os_html:
os_html.write(header + dir_title)
group.append(HTML('dir_title.html').render())
group.append(HTML("dir_title.html").render())
#Creating a list of all md files in the current directory
for temp in glob.glob(os.path.join(loc, operating_sys, '*.md')):
# Creating a list of all md files in the current directory
for temp in glob.glob(os.path.join(loc, operating_sys, "*.md")):
allmd.append(temp)
#Sorting all filenames in the directory, to maintain the order of the PDF
# Sorting all filenames in the directory, to maintain the order of the PDF
allmd.sort()
#Conversion of md to HTML
# Conversion of Markdown to HTML
for md in allmd:
with open(md, "r") as inp:
@@ -78,24 +81,24 @@ def main(loc, colorscheme):
out.write(html)
out.write(footer)
group.append(HTML('htmlout.html').render())
group.append(HTML("htmlout.html").render())
print("Rendered page {} of the directory {}".format(str(i), operating_sys))
i += 1
allmd.clear()
#Merging all the documents into a single PDF
# Merging all the documents into a single PDF
for doc in group:
for p in doc.pages:
ap.append(p)
#Writing the PDF to disk, preserving metadata of first tldr page
# Writing the PDF to disk, preserving metadata of first tldr page
group[2].copy(ap).write_pdf('tldr.pdf')
if os.path.exists("tldr.pdf"):
print("\nCreated tldr.pdf in the current directory!\n")
#Removing unnecessary intermediate files
# Removing unnecessary intermediate files
try:
os.remove("htmlout.html")
os.remove("title.html")
@@ -104,12 +107,12 @@ def main(loc, colorscheme):
print("Error removing temporary file(s)")
if __name__ == '__main__':
if __name__ == "__main__":
#Unless specified otherwise by the user, this is the default colorscheme
# Unless specified otherwise by the user, this is the default colorscheme
colorscheme = "basic"
#Parsing the arguments
# Parsing the arguments
parser = argparse.ArgumentParser()
parser.add_argument("dir_path", help = "Path to tldr 'pages' directory")
parser.add_argument("-c", choices=["solarized-light", "solarized-dark"], help="Color scheme of the PDF")

2
scripts/pdf/requirements.txt Normal file
View File

@@ -0,0 +1,2 @@
markdown
weasyprint

27
scripts/pdf/solarized-dark.css
View File

@@ -1,18 +1,8 @@
@font-face {
font-family: 'PT_Serif-Web-Regular';
src: url('PT_Serif-Web-Regular.ttf') format('truetype');
}
p {
margin-left: 2.5em;
}
code {
color: #b58900;
}
h1, h2, h4, ul {
font-family: "PT_Serif-Web-Regular";
color: #93a1a1;
}
@@ -20,21 +10,6 @@ body {
background-color: #002b36;
}
h1.titlemain {
text-align: center;
margin-top: 6em;
font-size: 350%;
}
h4.titlesub {
text-align: center;
font-size: 120%;
.title-sub {
color: #b58900;
}
h2.titledir {
text-align: center;
margin-top: 8.2em;
font-size: 300%;
}

26
scripts/pdf/solarized-light.css
View File

@@ -1,18 +1,8 @@
@font-face {
font-family: 'PT_Serif-Web-Regular';
src: url('PT_Serif-Web-Regular.ttf') format('truetype');
}
p {
margin-left: 2.5em;
}
code {
color: #dc322f
}
h1, h2, h4, ul {
font-family: "PT_Serif-Web-Regular";
color: #586e75;
}
@@ -20,20 +10,6 @@ body {
background-color: #fdf6e3;
}
h1.titlemain {
text-align: center;
margin-top: 6em;
font-size: 350%;
}
h4.titlesub {
text-align: center;
font-size: 120%;
.title-sub {
color: #dc322f
}
h2.titledir {
text-align: center;
margin-top: 8.2em;
font-size: 300%;
}