Markdown Editor

markdown-editor

Use Markdown Editor through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessE · Embedded

Tool IDmarkdown-editor

Version1

ExecutionCLIENT

WorkloadSTANDARD

ModesHeadless, Embedded

Quick actions

Input files 0–1Output files 1–2

Result handling → Recipes → Integration examples → Playground →

Input

Accepted input contract for this Tool.

Kind	file-or-data
File count	0 – 1
Accepted MIME types	text/markdown, text/plain

Parameters

Pass these values through request.options.

Parameter	Type	Required	Default	Allowed / Range	Description
`output`	enum	Optional	`html`	html \| markdown \| both	Generated file output. html creates an HTML file, markdown returns Markdown, both returns both files.
`sanitize`	boolean	Optional	`true`	—	Sanitize rendered HTML with DOMPurify before returning or exporting it.
`gfm`	boolean	Optional	`true`	—	Enable GitHub-Flavored Markdown features such as tables and task-list syntax.
`includeStyles`	boolean	Optional	`true`	—	Wrap HTML output in a standalone document with simple readable CSS.
`documentTitle`	string	Optional	`Markdown Document`	—	HTML document title used when includeStyles is enabled.

Output

Result contract returned after successful processing.

Type	files+data
File count	1 – 2
MIME types	text/html, text/markdown
Metadata	words, characters, lines, sanitized
ZIP archive	No

Basic usage

Choose a supported integration mode and copy the generated starter code.

Headless

const result = await client.run("markdown-editor", {
  
  options: { output: "html", sanitize: true, gfm: true, includeStyles: true }
});
console.log(result.files, result.data, result.metadata);

Embedded

await client.mount({ tool: "markdown-editor", target: "#zavilo-tool", mode: "embedded" });

This page is generated from the SDK Tool Definition used by the runtime.