Module

MarkdownIt

Package: purescript-markdown-it
Repository: nonbili/purescript-markdown-it

#renderString Source

renderString :: String -> Effect String

Parse and render markdown string to html string.

#MarkdownIt Source

data MarkdownIt

#Preset Source

data Preset

Constructors

Instances

Show Preset

#MarkdownItOptions Source

data MarkdownItOptions

Check https://markdown-it.github.io/markdown-it/#MarkdownIt.new to see available options.

#html Source

html :: Option MarkdownItOptions Boolean

#xhtmlOut Source

xhtmlOut :: Option MarkdownItOptions Boolean

#breaks Source

breaks :: Option MarkdownItOptions Boolean

#langPrefix Source

langPrefix :: Option MarkdownItOptions String

#linkify Source

linkify :: Option MarkdownItOptions Boolean

#typographer Source

typographer :: Option MarkdownItOptions Boolean

#quotes Source

quotes :: Option MarkdownItOptions String

#highlight Source

highlight :: Option MarkdownItOptions (String -> String -> String)

#newMarkdownIt Source

newMarkdownIt :: Preset -> Options MarkdownItOptions -> Effect MarkdownIt

Create a new MarkdownIt instance

#render Source

render :: String -> MarkdownIt -> Effect String

Use an existing MarkdownIt instance to render markdown string to html string.

#renderInline Source

renderInline :: String -> MarkdownIt -> Effect String

Similar to render, but without wrapping <p>.

#usePlugin Source

usePlugin :: String -> MarkdownIt -> Effect Unit

Load a plugin to an existing MarkdownIt instance. Different from the use method in markdown-it, the first argument here is the package name, not require('plugin-name').

Modules: MarkdownIt