adalal/gotenberg
1
0
Fork 0
mirror of https://github.com/gotenberg/gotenberg.git synced 2026-08-16 20:32:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

improving documentation

Browse Source
This commit is contained in:
Julien Neuhart
2018-12-10 20:08:45 +01:00
parent 5a28f3597c
commit 3a2467ccfe
4 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
build/docs/02-html.md
View File

@@ -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.

2
build/docs/03-markdown.md
View File

@@ -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:

2
build/docs/04-office.md
View File

@@ -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.