LiterateX.Types.TargetFormat

Type

data TargetFormat

Target format

This sum type defines the supported target formats.

Documentation:

• Pandoc Markdown
• GitHub Flavored Markdown
• mdBook Markdown

Since: 0.2.1.0

Constructors

PandocMarkdown

GitHubFlavoredMarkdown

MdBook

Instances

Bounded TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

minBound :: TargetFormat

maxBound :: TargetFormat

Enum TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

succ :: TargetFormat -> TargetFormat

pred :: TargetFormat -> TargetFormat

toEnum :: Int -> TargetFormat

fromEnum :: TargetFormat -> Int

enumFrom :: TargetFormat -> [TargetFormat]

enumFromThen :: TargetFormat -> TargetFormat -> [TargetFormat]

enumFromTo :: TargetFormat -> TargetFormat -> [TargetFormat]

enumFromThenTo :: TargetFormat -> TargetFormat -> TargetFormat -> [TargetFormat]

Show TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

showsPrec :: Int -> TargetFormat -> ShowS

show :: TargetFormat -> String

showList :: [TargetFormat] -> ShowS

Eq TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

(==) :: TargetFormat -> TargetFormat -> Bool

(/=) :: TargetFormat -> TargetFormat -> Bool

Ord TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

compare :: TargetFormat -> TargetFormat -> Ordering

(<) :: TargetFormat -> TargetFormat -> Bool

(<=) :: TargetFormat -> TargetFormat -> Bool

(>) :: TargetFormat -> TargetFormat -> Bool

(>=) :: TargetFormat -> TargetFormat -> Bool

max :: TargetFormat -> TargetFormat -> TargetFormat

min :: TargetFormat -> TargetFormat -> TargetFormat

Parse TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

parse :: (Textual t, Textual e) => t -> Either e TargetFormat

Render TargetFormat

Defined in LiterateX.Types.TargetFormat

Methods

render :: Textual t => TargetFormat -> t

API

describe :: TargetFormat -> String

Get a description of a target format

Since: 0.0.1.0

list :: [TargetFormat]

List of all supported target formats

Since: 0.0.1.0

mkEndCode :: TargetFormat -> Text

Make line in the target format to end a block of source code

Since: 0.0.1.0

mkBeginCode

Arguments

:: TargetFormat

-> Maybe CodeLanguage

-> Bool

True to number code lines

-> Int -> Text

make line for code starting at specified line number

Make line in the target format to begin a block of code

This function is written to indicate how it is used. Given the target format, optional code language, and line numbering flag, this function returns a function that takes a line number and returns a line.

The MdBook format does not support per-block line numbering, so the line numbering flag is ignored for that format.

Since: 0.0.1.0