Skip to content

Commit 5f42bda

Browse files
authored
Update README.md
1 parent 6b042e8 commit 5f42bda

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,22 @@
22
[Api2Pdf.com](https://www.api2pdf.com) | [Docs](https://www.api2pdf.com/documentation)
33

44
## What is Api2Pdf?
5-
Api2Pdf.com is a service for instantly generating PDFs from:
6-
- HTML
7-
- URLs
8-
- Microsoft Office documents (Word, Excel, Powerpoint)
9-
- Images
10-
- Merge / Concatenate two or more PDFs
5+
Api2Pdf.com is a service for instantly generating PDFs.
6+
7+
- [Get Started](#get-started)
8+
- [HTML](#convert-from-html)
9+
- [URLs](#convert-from-urls)
10+
- [Microsoft Office documents (Word, Excel, Powerpoint)](#convert-from-office)
11+
- [Images](#convert-from-office)
12+
- [Merge / Concatenate two or more PDFs](#merge)
13+
- [Helper Methods](#helper-methods)
14+
- [FAQ](#faq)
1115

1216
Api2Pdf provides access to **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**, along with the ability merge / concatenate PDFs together.
1317

1418

1519

16-
## Get Started
20+
## <a name="get-started"></a>Get Started
1721
This python library provides convenient methods for accessing the REST API [documented here](https://www.api2pdf.com/documentation/).
1822

1923
### Acquire API Key
@@ -65,7 +69,7 @@ Output:
6569

6670
## Documentation
6771

68-
### Convert HTML to PDF
72+
### <a name="convert-from-html"></a>Convert HTML to PDF
6973

7074
We support both **wkhtmltopdf** and **Headless Chrome** with the endpoint to convert raw html to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries.
7175

@@ -83,7 +87,7 @@ We support both **wkhtmltopdf** and **Headless Chrome** with the endpoint to con
8387
wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_html('<p>Hello World</p>')
8488
print(wkhtmltopdf_result.result)
8589

86-
### Convert URL to PDF
90+
### <a name="convert-from-url"></a>Convert URL to PDF
8791

8892
We support both wkhtmltopdf and Headless Chrome with the endpoint to convert urls to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries.
8993

@@ -102,7 +106,7 @@ We support both wkhtmltopdf and Headless Chrome with the endpoint to convert url
102106
wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_url('https://LINK-TO-YOUR-WEBSITE')
103107
print(wkhtmltopdf_result.result)
104108

105-
### Convert Microsoft Office Documents and Images to PDF
109+
### <a name="convert-from-office"></a>Convert Microsoft Office Documents and Images to PDF
106110

107111
We use **LibreOffice** to convert the following formats to PDF:
108112

@@ -118,7 +122,7 @@ You must provide a url to the file. Our engine will consume the file at that URL
118122
libreoffice_result = a2p.LibreOffice.convert_from_html('https://LINK-TO-YOUR-FILE')
119123
print(libreoffice_result.result)
120124

121-
### Merge / Concatenate Two or More PDFs
125+
### <a name="merge"></a>Merge / Concatenate Two or More PDFs
122126

123127
To use the merge endpoint, supply a list of urls to existing PDFs. The engine will consume all of the PDFs and merge them into a single PDF, in the order in which they were provided in the list.
124128

@@ -132,7 +136,7 @@ To use the merge endpoint, supply a list of urls to existing PDFs. The engine wi
132136
merge_result = a2p.merge(links_to_pdfs)
133137
print(merge_result.result)
134138

135-
### Helper Methods
139+
### <a name="helper-methods"></a>Helper Methods
136140

137141
##### Api2PdfResponse: download_pdf()
138142

@@ -148,7 +152,7 @@ On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy
148152
pdf_as_file_object = merge_result.download_pdf()
149153

150154

151-
## FAQ
155+
## <a name="faq"></a>FAQ
152156

153157
#### How do you bill?
154158
$1 will be deducted from your balance every month as long as you maintain an active account. This charge begins 30 days after your first sign up for the service. In addition, we charge $0.001 per megabyte (data in + data out). We require customers to maintain a positive balance on their account to use the service. You can turn off auto-recharge at any time and let your funds run out if you no longer wish to use the service. See our [pricing calculator](https://www.api2pdf.com/pricing/).
@@ -168,4 +172,4 @@ Api2Pdf does not set any specific limits on PDF file size, however our system do
168172
- Protected Office Documents
169173

170174
#### How long are PDFs stored on Api2Pdf.com?
171-
After generating a PDF via the API, you are provided with a link to the file. This link will hold the PDF for 24 hours. If you wish to keep your PDF long term, download the file to your local cache.
175+
After generating a PDF via the API, you are provided with a link to the file. This link will hold the PDF for 24 hours. If you wish to keep your PDF long term, download the file to your local cache.

0 commit comments

Comments
 (0)