From 3a2467ccfe43973e30478755e629570f1a40fb9c Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Mon, 10 Dec 2018 20:08:45 +0100 Subject: [PATCH] improving documentation --- build/docs/02-html.md | 6 +++--- build/docs/03-markdown.md | 2 +- build/docs/04-office.md | 2 +- docs/index.html | 10 +++++----- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/build/docs/02-html.md b/build/docs/02-html.md index 96f48881..2ae291f1 100644 --- a/build/docs/02-html.md +++ b/build/docs/02-html.md @@ -151,7 +151,7 @@ $filename = $client->store($request, $dirPath); ## Assets -You may also send additional files. For instance, images, fonts, stylesheets and so on. +You may also send additional files. For instance: images, fonts, stylesheets and so on. The only requirement is to make sure that their paths are on the same level as the `index.html` file. @@ -248,9 +248,9 @@ $filename = $client->store($request, $dirPath); ## Paper size, margins, orientation -You may also customize the resulting PDF paper. +You may also customize the resulting PDF format. -By default, it will be rendered in `A4` size with `1 inch` margins and `portrait` orientation. +By default, it will be rendered with `A4` size, `1 inch` margins and `portrait` orientation. > Paper size and margins have to be provided in `inches`. > Also, you have to set both `paperWidth` and `paperHeight`. Same for margins. diff --git a/build/docs/03-markdown.md b/build/docs/03-markdown.md index 999715a2..5ee11b39 100644 --- a/build/docs/03-markdown.md +++ b/build/docs/03-markdown.md @@ -11,7 +11,7 @@ It accepts `POST` requests with a `multipart/form-data` Content-Type. Markdown conversions work the same as HTML conversions. Only difference is that you have access to the Go template function `toHTML` -in the file `index.html` which will convert a given markdown file to HTML. +in the file `index.html`. This function will convert a given markdown file to HTML. For instance: diff --git a/build/docs/04-office.md b/build/docs/04-office.md index 18466486..29324ecc 100644 --- a/build/docs/04-office.md +++ b/build/docs/04-office.md @@ -2,7 +2,7 @@ title: Office --- -Gotenberg provides the endpoint `/convert/office` for Office documents conversions. +Gotenberg provides the endpoint `/convert/office` for Office document conversions. It accepts `POST` requests with a `multipart/form-data` Content-Type. diff --git a/docs/index.html b/docs/index.html index 421a75e9..65238887 100755 --- a/docs/index.html +++ b/docs/index.html @@ -306,7 +306,7 @@ Also, footer.html CSS properties override the ones from heade Assets -

You may also send additional files. For instance, images, fonts, stylesheets and so on.

+

You may also send additional files. For instance: images, fonts, stylesheets and so on.

The only requirement is to make sure that their paths are on the same level as the index.html file.

@@ -408,9 +408,9 @@ see to the fonts section.

Paper size, margins, orientation -

You may also customize the resulting PDF paper.

+

You may also customize the resulting PDF format.

-

By default, it will be rendered in A4 size with 1 inch margins and portrait orientation.

+

By default, it will be rendered with A4 size, 1 inch margins and portrait orientation.

Paper size and margins have to be provided in inches. @@ -492,7 +492,7 @@ Also, you have to set both paperWidth and paperHeight.

Markdown conversions work the same as HTML conversions.

Only difference is that you have access to the Go template function toHTML -in the file index.html which will convert a given markdown file to HTML.

+in the file index.html. This function will convert a given markdown file to HTML.

For instance:

@@ -563,7 +563,7 @@ in the file index.html which will convert a given markdown file to

Office

-

Gotenberg provides the endpoint /convert/office for Office documents conversions.

+

Gotenberg provides the endpoint /convert/office for Office document conversions.

It accepts POST requests with a multipart/form-data Content-Type.