Interface: RenderOptions

Defined in: renderer.ts:13

Extended by

• MarkdownExitOptions

Properties

breaks?

optional breaks: boolean;

Defined in: renderer.ts:26

Set true to convert \n in paragraphs into <br>.

Default

false

---

highlight?

optional highlight: 
  | (str, lang, attrs, env) => string | Promise<string>
  | null;

Defined in: renderer.ts:42

Highlighter function for fenced code blocks. Highlighter function (str, lang, attrs) should return escaped HTML. It can also return empty string if the source was not changed and should be escaped externally. If result starts with <pre... internal wrapper is skipped.

Default

null

---

langPrefix?

optional langPrefix: string;

Defined in: renderer.ts:33

CSS language class prefix for fenced blocks. Can be useful for external highlighters.

Default

'language-'

---

xhtmlOut?

optional xhtmlOut: boolean;

Defined in: renderer.ts:20

Set true to add '/' when closing single tags (<br />). This is needed only for full CommonMark compatibility. In real world you will need HTML output.

Default

false