Copyright	© 2017–present Mark Karpov
License	BSD 3 clause
Maintainer	Mark Karpov <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	GHC2021

Text.MMark.Internal.Type

Description

Internal type definitions. The public subset of these is re-exported from Text.MMark.Extension.

Since: 0.0.8.0

Synopsis

data MMark = MMark {
- mmarkYaml :: Maybe Value
- mmarkBlocks :: [Bni]
- mmarkExtension :: Extension
}
data Extension = Extension {
- extBlockTrans :: Endo Bni
- extBlockRender :: Render (Block (Ois, Html ()))
- extInlineTrans :: Endo Inline
- extInlineRender :: Render Inline
}
newtype Render a = Render {
- runRender :: (a -> Html ()) -> a -> Html ()
}
type Bni = Block (NonEmpty Inline)
data Block a
- = ThematicBreak
- | Heading1 a
- | Heading2 a
- | Heading3 a
- | Heading4 a
- | Heading5 a
- | Heading6 a
- | CodeBlock (Maybe Text) Text
- | Naked a
- | Paragraph a
- | Blockquote [Block a]
- | OrderedList Word (NonEmpty [Block a])
- | UnorderedList (NonEmpty [Block a])
- | Table (NonEmpty CellAlign) (NonEmpty (NonEmpty a))
data CellAlign
- = CellAlignDefault
- | CellAlignLeft
- | CellAlignRight
- | CellAlignCenter
data Inline
- = Plain Text
- | LineBreak
- | Emphasis (NonEmpty Inline)
- | Strong (NonEmpty Inline)
- | Strikeout (NonEmpty Inline)
- | Subscript (NonEmpty Inline)
- | Superscript (NonEmpty Inline)
- | CodeSpan Text
- | Link (NonEmpty Inline) URI (Maybe Text)
- | Image (NonEmpty Inline) URI (Maybe Text)
data Ois
mkOisInternal :: NonEmpty Inline -> Ois
getOis :: Ois -> NonEmpty Inline

Documentation

data MMark Source #

Representation of complete markdown document. You can't look inside of MMark on purpose. The only way to influence an MMark document you obtain as a result of parsing is via the extension mechanism.

Constructors

MMark
Fields mmarkYaml :: Maybe Value Parsed YAML document at the beginning (optional) mmarkBlocks :: [Bni] Actual contents of the document mmarkExtension :: Extension Extension specifying how to process and render the blocks

Instances

Instances details

Show MMark Source #	Dummy instance. Since: 0.0.5.0
Instance details Defined in Text.MMark.Internal.Type Methods showsPrec :: Int -> MMark -> ShowS # show :: MMark -> String # showList :: [MMark] -> ShowS #
NFData MMark Source #
Instance details Defined in Text.MMark.Internal.Type Methods rnf :: MMark -> () #

data Extension Source #

An extension. You can apply extensions with useExtension and useExtensions functions. The Text.MMark.Extension module provides tools for writing your own extensions.

Note that Extension is an instance of Semigroup and Monoid, i.e. you can combine several extensions into one. Since the (<>) operator is right-associative and mconcat is a right fold under the hood, the expression

l <> r

means that the extension r will be applied before the extension l, similar to how Endo works. This may seem counter-intuitive, but only with this logic we get consistency of ordering with more complex expressions:

e2 <> e1 <> e0 == e2 <> (e1 <> e0)

Here, e0 will be applied first, then e1, then e2. The same applies to expressions involving mconcat—extensions closer to beginning of the list passed to mconcat will be applied later.

Constructors

Extension
Fields extBlockTrans :: Endo Bni Block transformation extBlockRender :: Render (Block (Ois, Html ())) Block render extInlineTrans :: Endo Inline Inline transformation extInlineRender :: Render Inline Inline render

Instances

Instances details

Monoid Extension Source #
Instance details Defined in Text.MMark.Internal.Type Methods mempty :: Extension # mappend :: Extension -> Extension -> Extension # mconcat :: [Extension] -> Extension #
Semigroup Extension Source #
Instance details Defined in Text.MMark.Internal.Type Methods (<>) :: Extension -> Extension -> Extension # sconcat :: NonEmpty Extension -> Extension # stimes :: Integral b => b -> Extension -> Extension #

newtype Render a Source #

An internal type that captures the extensible rendering process we use. Render has a function inside which transforms a rendering function of the type a -> Html ().

Since: 0.0.8.0

Constructors

Render
Fields runRender :: (a -> Html ()) -> a -> Html ()

Instances

Instances details

Monoid (Render a) Source #
Instance details Defined in Text.MMark.Internal.Type Methods mempty :: Render a # mappend :: Render a -> Render a -> Render a # mconcat :: [Render a] -> Render a #
Semigroup (Render a) Source #
Instance details Defined in Text.MMark.Internal.Type Methods (<>) :: Render a -> Render a -> Render a # sconcat :: NonEmpty (Render a) -> Render a # stimes :: Integral b => b -> Render a -> Render a #

type Bni = Block (NonEmpty Inline) Source #

A shortcut for the frequently used type Block (NonEmpty Inline).

data Block a Source #

We can think of a markdown document as a collection of blocks—structural elements like paragraphs, block quotations, lists, headings, thematic breaks, and code blocks. Some blocks (like block quotes and list items) contain other blocks; others (like headings and paragraphs) contain inline content, see Inline.

We can divide blocks into two types: container blocks, which can contain other blocks, and leaf blocks, which cannot.

Constructors

ThematicBreak	Thematic break, leaf block
Heading1 a	Heading (level 1), leaf block
Heading2 a	Heading (level 2), leaf block
Heading3 a	Heading (level 3), leaf block
Heading4 a	Heading (level 4), leaf block
Heading5 a	Heading (level 5), leaf block
Heading6 a	Heading (level 6), leaf block
CodeBlock (Maybe Text) Text	Code block, leaf block with info string and contents
Naked a	Naked content, without an enclosing tag
Paragraph a	Paragraph, leaf block
Blockquote [Block a]	Blockquote container block
OrderedList Word (NonEmpty [Block a])	Ordered list (`Word` is the start index), container block
UnorderedList (NonEmpty [Block a])	Unordered list, container block
Table (NonEmpty CellAlign) (NonEmpty (NonEmpty a))	Table, first argument is the alignment options, then we have a `NonEmpty` list of rows, where every row is a `NonEmpty` list of cells, where every cell is an `a` thing. The first row is always the header row, because pipe-tables that we support cannot lack a header row. Since: 0.0.4.0

Instances

Instances details

Foldable Block Source #

Instance details

CellAlignDefault	No specific alignment specified
CellAlignLeft	Left-alignment
CellAlignRight	Right-alignment
CellAlignCenter	Center-alignment

Plain Text	Plain text
LineBreak	Line break (hard)
Emphasis (NonEmpty Inline)	Emphasis
Strong (NonEmpty Inline)	Strong emphasis
Strikeout (NonEmpty Inline)	Strikeout
Subscript (NonEmpty Inline)	Subscript
Superscript (NonEmpty Inline)	Superscript
CodeSpan Text	Code span
Link (NonEmpty Inline) URI (Maybe Text)	Link with text, destination, and optionally title
Image (NonEmpty Inline) URI (Maybe Text)	Image with description, URL, and optionally title