Skip to content
Preview of the Release notes (Markdown) template

210 × 297 mm

Reports

Release notes (Markdown)

Product release notes written in Markdown: a version header, highlights, changes grouped by type from one JSON list, an optional breaking-changes warning, upgrade steps and contributor thanks — rendered to a clean A4 PDF with the GitHub theme.

PDFA4 portraitLocale en-GBMarkdown

Opens Dynamic Document API with this template preloaded in a free workspace.

Generating this from your own data? See the Report Generation API.

Template language features

  • Loops
  • Conditionals
  • Filters
  • Date formatting
  • Grouping
  • Markdown

Filters such as format_currency and qrcode are described in the template language reference.

Variables

Derived from the sample data: 7 top-level fields, 20 paths in total. Send the same shape as data.

PathTypeExample
productobject
product.namestring"Tidewater Tasks"
product.support_emailstring"support@tidewater.example.com"
releaseobject
release.versionstring"4.2"
release.codenamestring"Kestrel"
release.datedate"2026-09-22"
release.summarystring"This release brings recurring tasks to every p…"
release.install_commandstring"npm install @tidewater/cli@4.2.0 && tidewater …"
highlightsarray<object> · 3
highlights[].titlestring"Recurring tasks"
highlights[].textstring"Repeat any task daily, weekly or on a custom s…"
breaking_changesarray<string> · 2"The `/v3/tasks/search` endpoint was removed; u…"
changesarray<object> · 7
changes[].typestring"added"
changes[].textstring"Recurring tasks with custom schedules"
changes[].areastring"Tasks"
changes[].ticketstring"TW-1182"
upgrade_stepsarray<string> · 3"Back up your workspace from Settings → Export."
contributorsarray<string> · 5"Amara Osei"

Render it with the API

After adding the template to your workspace, render it by ID and pass your data. Arrays are shortened here.

curl -X POST https://api-eu.dynamicdocumentapi.com/v1/renders \
  -H "Authorization: Bearer $DYNAMIC_DOCUMENT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "type": "template",
    "template_id": "tpl_01J9ZK3M7Q8V5W2X4Y6Z8A0B1C"
  },
  "data": {
    "product": {
      "name": "Tidewater Tasks",
      "support_email": "support@tidewater.example.com"
    },
    "release": {
      "version": "4.2",
      "codename": "Kestrel",
      "date": "2026-09-22",
      "summary": "This release brings recurring tasks to every plan, makes the board view twice as fast on large projects and adds a CSV import for teams moving over from spreadsheets.",
      "install_command": "npm install @tidewater/cli@4.2.0 && tidewater migrate --from 4.1"
    },
    "highlights": [
      {
        "title": "Recurring tasks",
        "text": "Repeat any task daily, weekly or on a custom schedule — now on every plan."
      },
      {
        "title": "Faster boards",
        "text": "Boards with 5,000+ cards open in under a second."
      }
    ],
    "breaking_changes": [
      "The `/v3/tasks/search` endpoint was removed; use `/v4/tasks?query=` instead.",
      "Webhook payloads now send dates as ISO 8601 strings in UTC."
    ],
    "changes": [
      {
        "type": "added",
        "text": "Recurring tasks with custom schedules",
        "area": "Tasks",
        "ticket": "TW-1182"
      },
      {
        "type": "added",
        "text": "CSV import with column mapping",
        "area": "Import",
        "ticket": "TW-1204"
      }
    ],
    "upgrade_steps": [
      "Back up your workspace from Settings → Export.",
      "Update the CLI and run the migration (below)."
    ],
    "contributors": [
      "Amara Osei",
      "Jun Takahashi"
    ]
  },
  "output": {
    "format": "pdf",
    "filename": "release-notes-markdown.pdf"
  }
}'