fixing website

2026-08-13 02:42:14 +01:00 · 2018-12-10 16:13:27 +01:00
parent 495203c112
commit 06e7a1fda1
19 changed files with 3 additions and 3 deletions
--- a/build/docs/03-markdown.md
+++ b/build/docs/03-markdown.md
@@ -0,0 +1,62 @@
+---
+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` which 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>
+```
+
+### Guzzle
+
+```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.MarkdownRequest{
+        IndexFilePath: "index.html",
+        MarkdownFilePaths: []string{
+            "file.md",
+        },
+    }
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### PHP
+
+TODO