Markdown-zu-PDF-API

Was Sie senden können

Der Text geht als markdown hinein, bis 1 MB in UTF-8, das sind mehrere hundert Seiten Fließtext. Ein YAML-Block als Front Matter am Anfang gibt dem PDF Titel, Autor, Thema und Stichwörter; ohne ihn ist die erste Überschrift der Titel. Eine Zeile \newpage beginnt eine neue Seite, [^1] macht eine Fußnote, und ein Link auf #umsatz-nach-region springt im PDF zu dieser Überschrift.

Ein Bild, das mit einem bloßen Dateinamen wie logo.png benannt ist, ist eine Datei der Dateibibliothek des Workspace; öffentliche https-Adressen und data:image/-Adressen funktionieren ebenso. Der Befehl oben fragt mit ?output=binary nach der Datei selbst; ohne das ist die Antwort JSON mit einem signierten Download-Link, der Seitenzahl und den Einheiten.

Text Ihrer Nutzer und von Modellen

In der Vorgabe erscheint rohes HTML im Text als Text, und nur <br> und einige Formatierungs-Tags wie <sup> und <mark> bleiben Tags, ohne Attribute. Links bleiben bei http, https, mailto und tel, Bilder bei https, data:image/ und der Bibliothek, sodass die Antwort eines Modells weder ein Skript ausführen noch einen Link auf javascript: setzen kann.

Für Markdown, das Sie selbst geschrieben haben, mit einem gestalteten Kasten oder einem eingebetteten Widget, schreibt settings.markdown.html: "allow" das HTML, wie es steht, so wie ein HTML-Rendering es tut:

{
  "markdown": "# Release notes\n\n<div class=\"note\">Version 2.4 is out.</div>",
  "settings": { "markdown": { "html": "allow" } }
}

Das Aussehen: das Theme, Ihr CSS, Ihre Marke

Das Theme document setzt den Text in Noto Sans und Code in einer Festbreitenschrift, hält Überschriften bei dem, was ihnen folgt, und bricht um, was breiter wäre als die Seite. Hat Ihre Organisation ein Brand-Kit, nehmen Überschriften und Text seine Schriften und Links seine Primärfarbe. theme: "none" lässt nur den Druck-Reset, und css, bis 256 kB, kommt nach beiden:

{
  "markdown": "# Release notes\n\n…",
  "settings": {
    "markdown": {
      "theme": "none",
      "css": ".ff-markdown { font-family: Georgia, serif; } .ff-markdown h1 { color: #0f766e; }"
    }
  }
}

Markdown mit Daten

Mit engine auf jinja2, liquid oder handlebars ist der Text eine Vorlage für die data, die Sie mitsenden, und wird danach als Markdown gelesen, mit allen Helpern für Beträge, Datumsangaben und Codes. Werte werden maskiert, sodass ein Wert Markdown bringen kann, aber kein HTML.

{
  "markdown": "# Report for {{ customer.name }}\n\n{% for item in items %}- {{ item.name }}: {{ item.total | money }}\n{% endfor %}",
  "engine": "jinja2",
  "data": {
    "customer": { "name": "Olvarest GmbH" },
    "items": [{ "name": "Consulting", "total": 960 }]
  }
}

Lesezeichen, PDF/UA-1 und PDF/A

Der Konverter schließt die Ebenen der Überschriften und füllt leere Tabellenzellen, und der Titel kommt aus dem Front Matter oder der ersten Überschrift. Mit settings.pdf.ua misst veraPDF die Datei vor der Auslieferung an den maschinell prüfbaren Regeln von PDF/UA-1, und das Rendering trägt das Urteil; die Alternativtexte schreiben Sie. settings.pdf.pdfa macht die Datei zu PDF/A-2b oder PDF/A-3b für die Archivierung, und settings.pdf.outline schreibt kostenlos Lesezeichen aus den Überschriften.

Was ein PDF kostet

Jeder Plan rendert Markdown. Ein PDF mit bis zu fünf Seiten ist eine Einheit, und je weitere fünf Seiten kommt eine hinzu. Der Free-Plan hat 100 Einheiten im Monat und fragt nach keiner Kreditkarte; Starter hat 3.000 Einheiten für 19 € im Monat. Renderings mit einem Test-Schlüssel kosten nichts, und ein Rendering, das fehlschlägt, wird nie gezählt. Alle Pläne stehen auf der Preisseite.