Markdown Renderer

Overview

You send Markdown and we return HTML that is safe to put straight on a page. Three grammars are available: strict CommonMark, GFM with tables, task lists, strikethrough and bare-URL links, and squillify-safe, which adds footnotes and GitHub-style callouts. Everything goes through an allowlist sanitizer, so scripts, event handlers, and dangerous URL schemes never survive, whatever your raw-HTML policy. You also get heading anchors, an optional table of contents, and a manifest of every image the document points at. Math, diagrams, and citations are selected through the closed components object. We render and sanitize — we do not fetch images, follow links, run code, or produce PDFs. Choosing between this and markdown.render_math: this is the one for a whole document, equations included — use components.math.mode and the same typesetting engine runs. Reach for markdown.render_math only when you need the expressions on their own as SVG fragments without the prose, the result written to a file, a malformed expression to fail the call instead of being preserved as source, or more than 100 expressions in one pass. This call is billed once. Parse, emit and sanitize cost 2 credits. Math that actually typesets adds 5 (the same weight as markdown.render_math); diagrams that actually render add 5 (markdown.render_diagrams); citations that actually resolve add 2 (markdown.render_citations). Those extras are included in this parent debit — the specialized skills are not invoked and not billed again. The settled total is 2 through 14 credits and is reported on _meta.usage. Omit components and we still reserve 12 credits up front, because math and diagrams default to auto; set a component's mode to off when you want it out of both the reservation and the work. Accepts file input via file_ref — no need to extract file content first.

Markdown from an agent or an end user is untrusted input, and turning it into HTML safely takes a sanitizer, a fixed grammar, and a stable theme — not a regex.

When to use it

Scope

Non-goals

• Does not fetch, validate, or embed the images and links it reports
• Does not produce PDF, DOCX, or other document formats
• Does not execute code blocks or evaluate expressions
• Does not highlight code server-side — it labels the language for your highlighter
• Does not repair invalid Markdown

Properties

Capabilities

Cost & billing

Flat rate per invocation

File handling

File limits

Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.

How we handle your data

Input schema

Output schema

API contract

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"markdown.render","input":{"markdown":"# Formula\n\n$E=mc^2$","components":{"math":{"mode":"auto"},"diagrams":{"mode":"off"},"citations":{"mode":"off"}}}}'

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("markdown.render", {"markdown":"# Hello\n\nWorld"});

Errors

Other limits

Limitations

• Does not fetch, validate, or embed the images and links it reports
• Does not produce PDF, DOCX, or other document formats
• Does not execute code blocks or evaluate expressions
• Does not highlight code server-side — it labels the language for your highlighter
• Does not repair invalid Markdown
• Converting Markdown to PDF or Word
• Highlighting code on the server
• Downloading or checking the images a document references
• Producing the typeset expressions on their own, or writing them to a file — that is markdown.render_math

How to call

POST /v1/execute (requires authentication)

{
  "skillKey": "markdown.render",
  "input": {
    "markdown": "# Hello\n\nWorld"
  }
}

Examples

{
  "markdown": "# Hello\n\nWorld"
}

{
  "warnings": 0,
  "html": "<article class=\"sqfy-markdown sqfy-markdown-v2 sqfy-theme-squillify\">\n <h1 id=\"md-hello\">Hello</h1>\n <p>World</p>\n</article>",
  "errors": 0,
  "toc": [
    {
      "text": "Hello",
      "id": "md-hello",
      "level": 1
    }
  ],
  "mimeType": "text/html; charset=utf-8",
  "diagnostics": [],
  "security": {
    "htmlPolicy": "sanitize",
    "removedElements": 0,
    "removedAttributes": 0,
    "blockedUrls": 0
  },
  "_meta": {
    "sanitizerVersion": "1.18.3",
    "themeVersion": "sqfy-markdown-v2",
    "inputChars": 14,
    "mathExpressions": 0,
    "parserVersion": "0.24.0",
    "truncated": false,
    "parser": "commonmark",
    "cssIncluded": false,
    "inputBytes": 14,
    "diagrams": 0,
    "usage": {
      "pricingModel": "markdown-composite-v1",
      "totalUnits": 2,
      "baseUnits": 2,
      "components": {}
    },
    "profile": "squillify-safe",
    "theme": "squillify",
    "citations": 0,
    "nodeCount": 4,
    "profileVersion": "1"
  },
  "assets": []
}

{
  "markdown": "See the [guide](docs/guide.md) and ![chart](chart.png).",
  "baseUri": "https://example.com/site/"
}

{
  "warnings": 0,
  "html": "<article class=\"sqfy-markdown sqfy-markdown-v2 sqfy-theme-squillify\">\n <p>See the <a href=\"https://example.com/site/docs/guide.md\">guide</a> and <img src=\"https://example.com/site/chart.png\" alt=\"chart\">.</p>\n</article>",
  "errors": 0,
  "toc": [],
  "mimeType": "text/html; charset=utf-8",
  "diagnostics": [],
  "security": {
    "htmlPolicy": "sanitize",
    "removedElements": 0,
    "removedAttributes": 0,
    "blockedUrls": 0
  },
  "_meta": {
    "sanitizerVersion": "1.18.3",
    "themeVersion": "sqfy-markdown-v2",
    "inputChars": 55,
    "mathExpressions": 0,
    "parserVersion": "0.24.0",
    "truncated": false,
    "parser": "commonmark",
    "cssIncluded": false,
    "inputBytes": 55,
    "diagrams": 0,
    "usage": {
      "pricingModel": "markdown-composite-v1",
      "totalUnits": 2,
      "baseUnits": 2,
      "components": {}
    },
    "profile": "squillify-safe",
    "theme": "squillify",
    "citations": 0,
    "nodeCount": 8,
    "profileVersion": "1"
  },
  "assets": [
    {
      "url": "https://example.com/site/chart.png",
      "alt": "chart",
      "type": "image",
      "external": false
    }
  ]
}

Recommended use cases

• Publish agent-written or user-written Markdown on a page without trusting it
• Render documentation with anchors and a table of contents
• Render technical documentation that mixes prose and equations, via components.math.mode=auto
• Preview a stored Markdown file exactly as it will appear

Avoid for

• Converting Markdown to PDF or Word
• Highlighting code on the server
• Downloading or checking the images a document references
• Producing the typeset expressions on their own, or writing them to a file — that is markdown.render_math

Related skills

Composable with

Safety & privacy

• Runs without calling any external service.
• Your payloads are never stored permanently.
• Telemetry captures metadata only — never your payload contents.
• We never train models on your payloads.
• No human reviews your payloads.

Tags