Safe Haskell	None
Language	Haskell2010

Cheapskate.Types

Synopsis

Documentation

data Doc Source

Structured representation of a document. The Options affect how the document is rendered by toHtml.

Constructors

Doc Options Blocks

Instances

Data Doc
Show Doc
ToMarkup Doc
Typeable * Doc

data Block Source

Block-level elements.

Constructors

Para Inlines
Header Int Inlines
Blockquote Blocks
List Bool ListType [Blocks]
CodeBlock CodeAttr Text
HtmlBlock Text
HRule

Instances

Data Block
Show Block
Typeable * Block

data CodeAttr Source

Attributes for fenced code blocks. codeLang is the first word of the attribute line, codeInfo is the rest.

Constructors

CodeAttr
Fields codeLang :: Text codeInfo :: Text

Instances

Data CodeAttr
Show CodeAttr
Typeable * CodeAttr

data ListType Source

Constructors

Bullet Char
Numbered NumWrapper Int

Instances

Eq ListType
Data ListType
Show ListType
Typeable * ListType

data NumWrapper Source

Constructors

PeriodFollowing
ParenFollowing

Instances

Eq NumWrapper
Data NumWrapper
Show NumWrapper
Typeable * NumWrapper

data HtmlTagType Source

Simple representation of HTML tag.

Constructors

Opening Text
Closing Text
SelfClosing Text

Instances

Data HtmlTagType
Show HtmlTagType
Typeable * HtmlTagType

type Blocks = Seq Block Source

data Inline Source

Inline elements.

Constructors

Str Text
Space
SoftBreak
LineBreak
Emph Inlines
Strong Inlines
Code Text
Link Inlines Text Text
Image Inlines Text Text
Entity Text
RawHtml Text

Instances

Data Inline
Show Inline
Typeable * Inline

type Inlines = Seq Inline Source

type ReferenceMap = Map Text (Text, Text) Source

data Options Source

Rendering and parsing options.

Constructors

Options
Fields sanitize :: Bool Sanitize raw HTML, link/image attributes allowRawHtml :: Bool Allow raw HTML (if false it gets escaped) preserveHardBreaks :: Bool Preserve hard line breaks in the source debug :: Bool Print container structure for debugging

Instances

Data Options
Show Options
Default Options
Typeable * Options