improving documentation

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

View File

@@ -151,7 +151,7 @@ $filename = $client->store($request, $dirPath);
## Assets ## 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 The only requirement is to make sure that their paths
are on the same level as the `index.html` file. are on the same level as the `index.html` file.
@@ -248,9 +248,9 @@ $filename = $client->store($request, $dirPath);
## Paper size, margins, orientation ## 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`. > Paper size and margins have to be provided in `inches`.
> Also, you have to set both `paperWidth` and `paperHeight`. Same for margins. > Also, you have to set both `paperWidth` and `paperHeight`. Same for margins.

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. Markdown conversions work the same as HTML conversions.
Only difference is that you have access to the Go template function `toHTML` 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: For instance:

View File

@@ -2,7 +2,7 @@
title: Office 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. It accepts `POST` requests with a `multipart/form-data` Content-Type.

View File

@@ -306,7 +306,7 @@ Also, <code>footer.html</code> CSS properties override the ones from <code>heade
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg>
</a>Assets</h2> </a>Assets</h2>
<p>You may also send additional files. For instance, images, fonts, stylesheets and so on.</p> <p>You may also send additional files. For instance: images, fonts, stylesheets and so on.</p>
<p>The only requirement is to make sure that their paths <p>The only requirement is to make sure that their paths
are on the same level as the <code>index.html</code> file.</p> are on the same level as the <code>index.html</code> file.</p>
@@ -408,9 +408,9 @@ see to the <a href="#office.fonts">fonts section</a>.</p>
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg>
</a>Paper size, margins, orientation</h2> </a>Paper size, margins, orientation</h2>
<p>You may also customize the resulting PDF paper.</p> <p>You may also customize the resulting PDF format.</p>
<p>By default, it will be rendered in <code>A4</code> size with <code>1 inch</code> margins and <code>portrait</code> orientation.</p> <p>By default, it will be rendered with <code>A4</code> size, <code>1 inch</code> margins and <code>portrait</code> orientation.</p>
<blockquote> <blockquote>
<p>Paper size and margins have to be provided in <code>inches</code>. <p>Paper size and margins have to be provided in <code>inches</code>.
@@ -492,7 +492,7 @@ Also, you have to set both <code>paperWidth</code> and <code>paperHeight</code>.
<p>Markdown conversions work the same as HTML conversions.</p> <p>Markdown conversions work the same as HTML conversions.</p>
<p>Only difference is that you have access to the Go template function <code>toHTML</code> <p>Only difference is that you have access to the Go template function <code>toHTML</code>
in the file <code>index.html</code> which will convert a given markdown file to HTML.</p> in the file <code>index.html</code>. This function will convert a given markdown file to HTML.</p>
<p>For instance:</p> <p>For instance:</p>
@@ -563,7 +563,7 @@ in the file <code>index.html</code> which will convert a given markdown file to
<h1 class="Heading"><a class="Anchor" aria-hidden="true" id="office" href="#office"> <h1 class="Heading"><a class="Anchor" aria-hidden="true" id="office" href="#office">
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg>
</a>Office</h1> </a>Office</h1>
<p>Gotenberg provides the endpoint <code>/convert/office</code> for Office documents conversions.</p> <p>Gotenberg provides the endpoint <code>/convert/office</code> for Office document conversions.</p>
<p>It accepts <code>POST</code> requests with a <code>multipart/form-data</code> Content-Type.</p> <p>It accepts <code>POST</code> requests with a <code>multipart/form-data</code> Content-Type.</p>