Markdown Plain-Text Renderer
markdown.render_plaintext
Overview
You send inline Markdown or a tenant-scoped file reference and receive deterministic semantic plain text. Links, images, tables, tasks, code, math, frontmatter, and blank lines follow explicit options. The skill never emits HTML, contacts MathJax, or fetches a URL. Treat the result as text; it is not certified for injection into HTML. Accepts file input via file_ref — no need to extract file content first.
Tag stripping loses Markdown structure; this skill defines a bounded, versioned semantic text projection.
Reliability
STRICT at a fixed profile version. MARKDOWN_PROFILE_UNSUPPORTED means the profile name is unknown and requires choosing commonmark, gfm, or squillify-safe; MARKDOWN_INVALID_ENCODING means a file is not strict UTF-8 and requires re-encoding before retrying; MARKDOWN_COMPLEXITY_LIMIT means the fixed node, depth, or math-expression cap was exceeded and requires splitting or simplifying the document. Truncation is opt-in and exact UTF-8 and code-point totals are always reported.
Context footprint
Input uses the shared Markdown size and depth caps. Text output is capped at 327680 UTF-8 bytes, below the platform's serialized JSON ceiling. A successful call costs 1 execution credit.
When to use it
When a downstream system needs readable text rather than HTML.
When the result will be injected as markup or needs typeset math.
Powered by commonmark-java and Squillify's bounded text emitter.
Scope
Non-goals
- Does not sanitize output for HTML injection
- Does not render HTML or SVG
- Does not fetch links or images
- Does not summarize or translate content
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.
| Limit | Value | Limited by |
|---|---|---|
| Maximum size per input file | 2 MiB | Skill maximum |
How we handle your data
What this means
This skill may receive sensitive content and may return submitted, transformed, extracted, or reformatted content.
Squillify guarantees
- Runs inside Squillify using a self-contained open-source component
- This skill runs inside Squillify.
- Payloads are not sent to an external service by this skill.
- Self contained open source component
- Squillify does not permanently store submitted payloads.
- Telemetry records metadata only, not submitted content.
- Submitted payloads are not used for training.
- Submitted payloads are not reviewed by humans.
- This skill does not target sensitive data.
- The response may contain submitted or transformed content.
Your responsibility
Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| markdown | string | No | Inline Markdown up to 1048576 characters. Omit only when file_ref is present. If both are present, file_ref wins and _meta._input_conflict_resolved reports it. |
| file_ref | string | No | Tenant-scoped UTF-8 Markdown file up to 2097152 bytes. When omitted, the inline markdown field is used. |
| profile | string | No | commonmark, gfm, or squillify-safe; defaults to squillify-safe. |
| options | object | No | Closed presentation options for links, images, tables, tasks, code, math, frontmatter, and blank-line collapsing. When omitted, defaults are linkStyle=label_and_url, imageStyle=alt_text, tableStyle=tsv, taskStyle=checkbox, codeStyle=preserve, mathStyle=source, includeFrontmatter=false, and collapseBlankLines=true. |
| limits | object | No | Optional timeoutMs, maxOutputUtf8Bytes (1..327680), and allowTruncation. Defaults are timeoutMs=5000, maxOutputUtf8Bytes=327680, and allowTruncation=false. Unknown properties are rejected. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| text | string | Yes | Plain text, capped by UTF-8 bytes without splitting a Unicode cluster. |
| _meta | object | Yes | Closed profile and parser identity, input size, exact original and returned UTF-8 byte and code-point counts, and truncation state. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"markdown.render_plaintext","input":{"markdown":"# Guide\n\nSee [docs](https://example.com)."}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("markdown.render_plaintext", {"markdown":"# Guide\n\nSee [docs](https://example.com)."});Errors
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
| MARKDOWN_PROFILE_UNSUPPORTED | 400 | No | The request payload failed this skill's input validation. |
| MARKDOWN_INVALID_ENCODING | 400 | No | The request payload failed this skill's input validation. |
| MARKDOWN_COMPLEXITY_LIMIT | 429 | No | A size, quota, rate, or time limit was exceeded. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not sanitize output for HTML injection
- Does not render HTML or SVG
- Does not fetch links or images
- Does not summarize or translate content
- Browser-ready output
- HTML sanitization
- Math typesetting
- Remote link checks
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "markdown.render_plaintext",
"input": {
"markdown": "# Guide\n\nSee [docs](https://example.com)."
}
}Examples
Keep a link label and URL
{
"markdown": "# Guide\n\nSee [docs](https://example.com)."
}{
"_meta": {
"originalUtf8Bytes": 38,
"bomStripped": false,
"nodeCount": 7,
"lineEndingsNormalized": false,
"profileVersion": "1",
"originalCodePoints": 38,
"returnedUtf8Bytes": 38,
"returnedCodePoints": 38,
"parserVersion": "0.24.0",
"parser": "commonmark",
"inputChars": 41,
"profile": "squillify-safe",
"truncated": false,
"inputBytes": 41
},
"text": "Guide\n\nSee docs (https://example.com)."
}Return a small deterministic prefix
{
"markdown": "alpha beta",
"limits": {
"allowTruncation": true,
"maxOutputUtf8Bytes": 5
}
}{
"_meta": {
"originalUtf8Bytes": 10,
"bomStripped": false,
"nodeCount": 2,
"lineEndingsNormalized": false,
"profileVersion": "1",
"originalCodePoints": 10,
"returnedUtf8Bytes": 5,
"returnedCodePoints": 5,
"parserVersion": "0.24.0",
"parser": "commonmark",
"inputChars": 10,
"profile": "squillify-safe",
"truncated": true,
"inputBytes": 10
},
"text": "alpha"
}Recommended use cases
- Search indexing and embeddings
- Text notifications and previews
- Accessible text fallbacks
- Plain-text export
Avoid for
- Browser-ready output
- HTML sanitization
- Math typesetting
- Remote link checks
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.