Markdown in PDF umwandeln mit Ruby

Was Sie brauchen

• Einen API-Key. Legen Sie ihn in der App unter API-Schlüssel an und exportieren Sie ihn als FORMFEED_API_KEY. Zum Ausprobieren ist ein Test-Key (ff_test_…) richtig. Siehe Quickstart.
• Ruby. Sie brauchen Ruby 3; das Programm nutzt net/http und json aus der Standardbibliothek.
• Eine Markdown-Datei. report.md neben dem Programm, bis 1 MB. Ein Beispiel steht weiter unten.

Das Programm

Das Programm liest report.md, sendet sie als markdown mit Lesezeichen aus ihren Überschriften, wartet auf das Ergebnis, wenn die API mit 202 antwortet, bricht mit der Meldung der API ab, wenn etwas nicht stimmt, und speichert das PDF.

require "json"
require "net/http"

body = {
  markdown: File.read("report.md"),
  settings: {
    pdf: { outline: true },
  },
}
auth = { "Authorization" => "Bearer #{ENV.fetch("FORMFEED_API_KEY")}" }

response = Net::HTTP.post(
  URI("https://api-eu.formfeed.dev/v1/renders"),
  JSON.generate(body),
  auth.merge("Content-Type" => "application/json")
)
render = JSON.parse(response.body)

# not done within 60 seconds: the answer is 202 and the render goes on in the background;
# its result answers the same way until the render has finished
while response.code == "202"
  sleep 2
  response = Net::HTTP.get_response(URI("https://api-eu.formfeed.dev/v1/renders/#{render["id"]}/result"), auth)
  render = JSON.parse(response.body)
end

# every error is a problem document (RFC 9457) with a title and a detail
abort "#{render["title"]}: #{render["detail"]}" unless response.is_a?(Net::HTTPSuccess)

File.binwrite("report.pdf", Net::HTTP.get(URI(render["download_url"])))
puts "#{render["id"]} #{render["page_count"]} page(s), #{render["units"]} unit(s)"

Ausführen

Es gibt die ID des Renderings, die Seitenzahl und die verbrauchten Einheiten aus, und report.pdf liegt neben dem Programm.

export FORMFEED_API_KEY=ff_test_...
ruby render.rb

Was an Ruby besonders ist

• Hashes werden zu JSON. Symbol-Keys sind in Ordnung: JSON.generate schreibt sie als Strings, und die snake_case-Namen der API sind ohnehin idiomatisches Ruby.
• abort mit dem Problem. Ein Problem-Dokument enthält title und detail; das Programm gibt beides aus und endet mit Status 1.
• In Rails. Legen Sie den Aufruf in einen Job (Active Job, Sidekiq), nicht in den Request-Zyklus: Ein synchrones Rendering antwortet, wenn das PDF fertig ist, und das kann bis zu 60 Sekunden dauern, bevor die API mit 202 antwortet und im Hintergrund fertig rendert.

Eine Markdown-Datei mit Titel

Das Front Matter gibt dem PDF Titel und Autor; ohne es ist die erste Überschrift der Titel. Eine Zeile \newpage beginnt eine neue Seite, und ein Link auf eine Überschrift funktioniert im PDF:

---
title: Release notes 2.4
author: Fennlor Studio GmbH
---

# Release notes 2.4

## What is new

- Faster previews, see [the numbers](#numbers)
- Footnotes in the export[^1]
- [x] Tested on every plan

## Numbers

| Step    | Before | After  |
| :------ | -----: | -----: |
| Preview | 840 ms | 310 ms |
| Export  | 2.1 s  | 1.4 s  |

\newpage

## Thanks

To everyone who reported a problem.

[^1]: From version 2.4 on.

Was die Einstellungen steuern

• Aussehen. settings.markdown.theme ist document, das den Text gestaltet, in Schriften und Farbe des Brand-Kits, wo der Workspace eines hat, oder none; settings.markdown.css kommt danach.
• Rohes HTML. In der Vorgabe als Text gezeigt. settings.markdown.html: "allow" schreibt es, wie es steht, für Markdown, das Sie selbst geschrieben haben, nie für Text Ihrer Nutzer oder eines Modells.
• Zeilenumbrüche. settings.markdown.breaks: true macht einen einzelnen Zeilenumbruch zu einem Zeilenumbruch, für Text aus einem Chat.
• Papier, Kopf- und Fußzeile. paper, margin, header.html und footer.html funktionieren wie bei HTML; Elemente mit den Klassen pageNumber und totalPages zeigen die Seitenzahlen.

Platzhalter im Markdown

Mit "engine": "jinja2" (oder liquid, handlebars) und einem data-Objekt wird {{ … }} im Text gefüllt, bevor er als Markdown gelesen wird, mit allen Helpern. Der Markdown-Guide erklärt den Rest.

Wenn die API nein sagt

• Eine Form für jeden Fehler. Fehler sind Problem-Dokumente (RFC 9457) mit type, title, status, detail, einem stabilen code und der request_id, die Sie dem Support nennen; die type-URL führt zu einer Seite über diesen Fehler. Die Liste steht in der Fehlerreferenz.
• Die üblichen. 401 unauthorized bei fehlendem oder widerrufenem Schlüssel, 404 template_not_found bei falschem Vorlagennamen, 422 template_runtime_error, wenn die Vorlage an den Daten scheitert, 429 rate_limited über den Anfragen pro Sekunde des Tarifs, 402 quota_exceeded, wenn die Einheiten des Free-Tarifs verbraucht sind (ein bezahlter Tarif rechnet weitere Einheiten ab, bis zu seiner Obergrenze).
• Sicher wiederholen. Senden Sie beim POST einen Idempotency-Key-Header und wiederholen Sie die Anfrage mit demselben Schlüssel, wenn Sie nicht wissen, ob der erste Versuch ankam: 24 Stunden lang liefert der Schlüssel die erste Antwort, statt erneut zu rendern und zu berechnen. Gespeichert wird die Antwort, sobald der erste Versuch beantwortet ist; wiederholen Sie also nicht, solange er noch laufen kann. Auch Probleme unter 500 werden gespeichert, eine korrigierte Anfrage braucht deshalb einen neuen Schlüssel.

Die Aufgabe um dieses Programm

Dieser Guide ist ein Programm. Was die Aufgabe darum herum braucht, von der Vorlage bis zu Limits und Preis, steht auf der Seite Markdown-zu-PDF-API.

Weitere Guides für Ruby

• PDF-Rechnung aus JSON erzeugen mit Ruby
• ZUGFeRD-E-Rechnung erstellen mit Ruby
• HTML in PDF umwandeln mit Ruby
• Open-Graph-Bilder erzeugen mit Ruby
• PDFs aus einer CSV erzeugen mit Ruby
• PDFs zusammenfügen und mit Passwort schützen mit Ruby
• PDF asynchron rendern und den Webhook prüfen mit Ruby