From 5a28f3597cb3a12b944522ba678ce0a61b7ccead Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 10 Dec 2018 19:59:45 +0100 Subject: [PATCH] fixing typos in documentation --- build/docs/02-html.md | 8 ++++---- build/docs/03-markdown.md | 2 +- build/docs/04-office.md | 2 +- build/docs/05-merge.md | 2 +- build/docs/06-webhook.md | 5 ++--- docs/index.html | 35 +++++++++++++++++------------------ 6 files changed, 26 insertions(+), 28 deletions(-) diff --git a/build/docs/02-html.md b/build/docs/02-html.md index 53a6833c..96f48881 100644 --- a/build/docs/02-html.md +++ b/build/docs/02-html.md @@ -26,7 +26,7 @@ For instance: ``` -### Guzzle +### cURL ```bash $ curl --request POST \ @@ -100,7 +100,7 @@ The following classes allow you to inject printing values: > **Attention:** the CSS properties are independant of the ones used in the `index.html` file. > Also, `footer.html` CSS properties override the ones from `header.html`. -### Guzzle +### cURL ```bash $ curl --request POST \ @@ -193,7 +193,7 @@ You may also use *remote* paths for Google fonts, images and so on. > If you want to install fonts directly in the Gotenberg Docker image, > see to the [fonts section](#office.fonts). -### Guzzle +### cURL ```bash $ curl --request POST \ @@ -255,7 +255,7 @@ By default, it will be rendered in `A4` size with `1 inch` margins and `portrait > Paper size and margins have to be provided in `inches`. > Also, you have to set both `paperWidth` and `paperHeight`. Same for margins. -### Guzzle +### cURL ```bash $ curl --request POST \ diff --git a/build/docs/03-markdown.md b/build/docs/03-markdown.md index e5aa794c..999715a2 100644 --- a/build/docs/03-markdown.md +++ b/build/docs/03-markdown.md @@ -28,7 +28,7 @@ For instance: ``` -### Guzzle +### cURL ```bash $ curl --request POST \ diff --git a/build/docs/04-office.md b/build/docs/04-office.md index 95e9522f..18466486 100644 --- a/build/docs/04-office.md +++ b/build/docs/04-office.md @@ -26,7 +26,7 @@ All files will be merged into a single resulting PDF. > That's why for Office conversions, the API does only one conversion at a time. > See the [scalability section](#scalability) to find how to mitigate this issue. -### Guzzle +### cURL ```bash $ curl --request POST \ diff --git a/build/docs/05-merge.md b/build/docs/05-merge.md index 35d48c3e..3f1bb677 100644 --- a/build/docs/05-merge.md +++ b/build/docs/05-merge.md @@ -11,7 +11,7 @@ It accepts `POST` requests with a `multipart/form-data` Content-Type. Nothing special here: you may send one or more PDF files and the API will merge them and return the resulting PDF file. -### Guzzle +### cURL ```bash $ curl --request POST \ diff --git a/build/docs/06-webhook.md b/build/docs/06-webhook.md index 3a634787..c41f2ca2 100644 --- a/build/docs/06-webhook.md +++ b/build/docs/06-webhook.md @@ -7,11 +7,11 @@ All endpoints accept a form field named `webhookURL`. If provided, the API will send the resulting PDF file in a `POST` request with the `application/pdf` Content-Type to given URL. -By doing so, your requests to the API will be done before the conversions are actually done! +By doing so, your requests to the API will be over before the conversions are actually done! ## Examples -### Guzzle +### cURL ```bash $ curl --request POST \ @@ -19,7 +19,6 @@ $ curl --request POST \ --header 'Content-Type: multipart/form-data' \ --form files=@index.html --form webhookURL='http://myapp.com/webhook/' - > result.pdf ``` ### Go diff --git a/docs/index.html b/docs/index.html index 4586bbde..421a75e9 100755 --- a/docs/index.html +++ b/docs/index.html @@ -168,9 +168,9 @@ which will be converted to PDF.

</html> -

Guzzle

+cURL

$ curl --request POST \
     --url http://localhost:3000/convert/html \
@@ -250,9 +250,9 @@ Respectively, a file named header.html and footer.html
 Also, footer.html CSS properties override the ones from header.html.

 
 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/convert/html \
@@ -348,9 +348,9 @@ are on the same level as the index.html file.

 see to the fonts section.

 
 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/convert/html \
@@ -417,9 +417,9 @@ see to the fonts section.

 Also, you have to set both paperWidth and paperHeight. Same for margins.

 
 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/convert/html \
@@ -508,9 +508,9 @@ in the file index.html which will convert a given markdown file to
 </html>
 

 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/convert/markdown \
@@ -593,9 +593,9 @@ That’s why for Office conversions, the API does only one conversion at a time.
 See the scalability section to find how to mitigate this issue.

 
 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/convert/office \
@@ -672,9 +672,9 @@ See the scalability section to find how to mitigate t
 
Nothing special here: you may send one or more PDF files and the API
 will merge them and return the resulting PDF file.

 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/merge \
@@ -732,22 +732,21 @@ will merge them and return the resulting PDF file.

 
If provided, the API will send the resulting PDF file in a POST request with the application/pdf Content-Type
 to given URL.

 
-
By doing so, your requests to the API will be done before the conversions are actually done!

+
By doing so, your requests to the API will be over before the conversions are actually done!

 
 
Examples

 
-
Guzzle

+cURL

 
 
$ curl --request POST \
     --url http://localhost:3000/convert/html \
     --header 'Content-Type: multipart/form-data' \
     --form files=@index.html
     --form webhookURL='http://myapp.com/webhook/'
-    > result.pdf