4.0.0 (#42)

* adding URL conversions

* updating gotenberg version in documentation

* pkg: input as variadic string (#39)

* pkg: input as variadic string

* pkg: fix link to github doc

* update doc about v4 client

* make doc

* fixing missing variadic inputs in doc

* adding more fonts

* updating PHP documentation

build/docs/content/01-install.md

@@ -7,7 +7,7 @@ Gotenberg is shipped within a Docker image.
 You may start it with:
 
 ```bash
-$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:3
+$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:4
 ```
 
 > The API will be available at [http://localhost:3000](http://localhost:3000).
@@ -22,7 +22,7 @@ services:
   # your others services
 
   gotenberg:
-    image: thecodingmachine/gotenberg:3
+    image: thecodingmachine/gotenberg:4
 ```
 
 > The API will be available under `gotenberg:3000` in your Docker Compose network.

build/docs/content/02-html.md

@@ -185,7 +185,7 @@ But this won't:
 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).
+> see to the [fonts section](#fonts).
 
 ### cURL
 
@@ -208,11 +208,7 @@ import "github.com/thecodingmachine/gotenberg/pkg"
 func main() {
     c := &gotenberg.Client{Hostname: "http://localhost:3000"}
     req, _ := gotenberg.NewHTMLRequest("index.html")
-    req.SetAssets([]string{
-        "font.woff",
-        "img.gif",
-        "style.css",
-    })
+    req.SetAssets("font.woff", "img.gif", "style.css")
     dest := "result.pdf"
     c.Store(req, dest)
 }
@@ -234,8 +230,8 @@ $assets = [
 ];
 $request = new HTMLRequest($index);
 $request->setAssets($assets);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
+$dest = "result.pdf";
+$client->store($request, $dest);
 ```
 
 ## Paper size, margins, orientation
@@ -294,6 +290,6 @@ $request = new HTMLRequest($index);
 $request->setPaperSize(Request::A4);
 $request->setMargins(Request::NO_MARGINS);
 $request->setLandscape(true);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
+$dest = "result.pdf";
+$client->store($request, $dest);
 ```

build/docs/content/03-url.md

@@ -0,0 +1,56 @@
+---
+title: URL
+---
+
+Gotenberg provides the endpoint `/convert/url` for remote URL conversions.
+
+It accepts `POST` requests with a `multipart/form-data` Content-Type.
+
+## Basic
+
+This endpoint does not accept an `index.html` file nor assets files but a form field
+named `remoteURL` instead. Otherwise, URL conversions work the same as HTML conversions.
+
+> **Attention:** when converting a website to PDF, you should remove all margins.
+> If not, some of the content of the page might be hidden.
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/url \
+    --header 'Content-Type: multipart/form-data' \
+    --form remoteURL=https://google.com
+    --form marginTop=0 \
+    --form marginBottom=0 \
+    --form marginLeft=0 \
+    --form marginRight=0 \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg/pkg"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req := gotenberg.NewURLRequest("https://google.com")
+    req.SetMargins(gotenberg.NoMargins)
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\URLRequest;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$request = new URLRequest('https://google.com');
+$request->setMargins(Request::NO_MARGINS);
+$dest = "result.pdf";
+$filename = $client->store($request, $dest);
+```

build/docs/content/04-markdown.md

@@ -46,7 +46,7 @@ import "github.com/thecodingmachine/gotenberg/pkg"
 
 func main() {
     c := &gotenberg.Client{Hostname: "http://localhost:3000"}
-    req, _ := gotenberg.NewMarkdownRequest("index.html", []string{"file.md"})
+    req, _ := gotenberg.NewMarkdownRequest("index.html", "file.md")
     dest := "result.pdf"
     c.Store(req, dest)
 }
@@ -65,6 +65,6 @@ $markdowns = [
     DocumentFactory::makeFromPath('file.md', 'file.md'),
 ];
 $request = new MarkdownRequest($index, $markdowns);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
+$dest = "result.pdf";
+$filename = $client->store($request, $dest);
 ```

build/docs/content/05-office.md

@@ -46,7 +46,7 @@ import "github.com/thecodingmachine/gotenberg/pkg"
 
 func main() {
     c := &gotenberg.Client{Hostname: "http://localhost:3000"}
-    req, _ := gotenberg.NewOfficeRequest([]string{"document.docx", "document2.docx"})
+    req, _ := gotenberg.NewOfficeRequest("document.docx", "document2.docx")
     dest := "result.pdf"
     c.Store(req, dest)
 }
@@ -65,8 +65,8 @@ $files = [
     DocumentFactory::makeFromPath('document2.docx', 'document2.docx'),
 ];
 $request = new OfficeRequest($files);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
+$dest = "result.pdf";
+$filename = $client->store($request, $dest);
 ```
 
 ## Orientation
@@ -93,7 +93,7 @@ import "github.com/thecodingmachine/gotenberg/pkg"
 
 func main() {
     c := &gotenberg.Client{Hostname: "http://localhost:3000"}
-    req, _ := gotenberg.NewOfficeRequest([]string{"document.docx"})
+    req, _ := gotenberg.NewOfficeRequest("document.docx")
     req.SetLandscape(true)
     dest := "result.pdf"
     c.Store(req, dest)
@@ -113,18 +113,6 @@ $files = [
 ];
 $request = new OfficeRequest($files);
 $request->setLandscape(true);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
-```
-
-## Fonts
-
-By default, only `ttf-mscorefonts` fonts are installed.
-
-If you wish to use more fonts, you will have to create your own image:
-
-```Dockerfile
-FROM thecodingmachine/gotenberg:3
-
-RUN apt-get -y install yourfonts
+$dest = "result.pdf";
+$filename = $client->store($request, $dest);
 ```

build/docs/content/06-merge.md

@@ -29,7 +29,7 @@ import "github.com/thecodingmachine/gotenberg/pkg"
 
 func main() {
     c := &gotenberg.Client{Hostname: "http://localhost:3000"}
-    req, _ := gotenberg.NewMergeRequest([]string{"file.pdf", "file2.pdf"})
+    req, _ := gotenberg.NewMergeRequest("file.pdf", "file2.pdf")
     dest := "result.pdf"
     c.Store(req, dest)
 }
@@ -48,6 +48,6 @@ $files = [
     DocumentFactory::makeFromPath('file2.pdf', 'file2.pdf'),
 ];
 $request = new MergeRequest($files);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
+$dest = "result.pdf";
+$filename = $client->store($request, $dest);
 ```

build/docs/content/08-scalability.md

@@ -14,7 +14,7 @@ services:
   # your others services
 
   gotenberg:
-    image: thecodingmachine/gotenberg:3
+    image: thecodingmachine/gotenberg:4
 ```
 
 You may now launch your services using:

build/docs/content/10-fonts.md

@@ -0,0 +1,13 @@
+---
+title: Fonts
+---
+
+By default, a handful of fonts are installed. Asian characters are also supported out of the box.
+
+If you wish to use more fonts, you will have to create your own image:
+
+```Dockerfile
+FROM thecodingmachine/gotenberg:4
+
+RUN apt-get -y install yourfonts
+```