fixing docs generation: was adding Dockerfile too..

2026-08-16 12:22:17 +01:00 · 2018-12-14 09:15:51 +01:00
parent a15cf33691
commit 3f7b006d16
11 changed files with 1 additions and 73 deletions
--- a/build/docs/content/03-markdown.md
+++ b/build/docs/content/03-markdown.md
@@ -0,0 +1,70 @@
+---
+title: Markdown
+---
+
+Gotenberg provides the endpoint `/convert/markdown` for Markdown conversions.
+
+It accepts `POST` requests with a `multipart/form-data` Content-Type.
+
+## Basic
+
+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`. This function will convert a given markdown file to HTML.
+
+For instance:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>My PDF</title>
+  </head>
+  <body>
+    {{ toHTML .DirPath "file.md" }}
+  </body>
+</html>
+```
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/markdown \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form files=@file.md \
+    > result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg/pkg"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewMarkdownRequest("index.html", []string{"file.md"})
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\MarkdownRequest;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$markdowns = [
+    DocumentFactory::makeFromPath('file.md', 'file.md'),
+];
+$request = new MarkdownRequest($index, $markdowns);
+$dirPath = "/foo";
+$filename = $client->store($request, $dirPath);
+```