MarkedOptions

io.laminext.markdown.markedjs.MarkedOptions$
See theMarkedOptions companion class

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Concrete methods

def apply(highlight: UndefOr[(String, UndefOr[String], Function) => String], renderer: MarkedRenderer, gfm: Boolean, tables: Boolean, breaks: Boolean, pedantic: Boolean, sanitize: Boolean, smartLists: Boolean, smartypants: Boolean): MarkedOptions

Attributes

breaks

Enable GFM line breaks. This option requires the gfm option to be true.

gfm

Enable GitHub flavored markdown.

highlight

A function to highlight code blocks

pedantic

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

renderer

An object containing functions to render tokens to HTML.

sanitize

Sanitize the output. Ignore any HTML that has been input.

smartLists

Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.

smartypants

Use "smart" typograhic punctuation for things like quotes and dashes.

tables

Enable GFM tables. This option requires the gfm option to be true.