format

format

Type: "markdown" | "html" Default: "html"

Sets the content format for the entire document body. When set to "markdown", ReSpec interprets the document body as GitHub Flavored Markdown.

Basic usage

var respecConfig = {
  format: "markdown",
};

Notes

• To use Markdown for only specific included sections, use data-include-format="markdown" instead of setting this globally
• When using format: "markdown", keep all text flushed to the left — Markdown is whitespace-sensitive
• See the Markdown guide for detailed usage, examples, and known limitations