LiterateX.Types

The type modules are generally imported qualified, so the types are re-exported by this module for convenience.

Documentation

data CodeLanguage

Source code language

This string is used for syntax highlighting of source code.

When using Pandoc Markdown, run the following command to see a list of supported languages:

$ pandoc --list-highlight-languages

When using GitHub Flavored Markdown, check the following file for supported languages:

https://github.com/github/linguist/blob/master/lib/linguist/languages.yml

Since: 0.0.1.0

Instances

IsString CodeLanguage

Defined in LiterateX.Types.CodeLanguage

Methods

fromString :: String -> CodeLanguage

Show CodeLanguage

Defined in LiterateX.Types.CodeLanguage

Methods

showsPrec :: Int -> CodeLanguage -> ShowS

show :: CodeLanguage -> String

showList :: [CodeLanguage] -> ShowS

Eq CodeLanguage

Defined in LiterateX.Types.CodeLanguage

Methods

(==) :: CodeLanguage -> CodeLanguage -> Bool

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

Ord CodeLanguage

Defined in LiterateX.Types.CodeLanguage

Methods

compare :: CodeLanguage -> CodeLanguage -> Ordering

(<) :: CodeLanguage -> CodeLanguage -> Bool

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

(>) :: CodeLanguage -> CodeLanguage -> Bool

(>=) :: CodeLanguage -> CodeLanguage -> Bool

max :: CodeLanguage -> CodeLanguage -> CodeLanguage

min :: CodeLanguage -> CodeLanguage -> CodeLanguage

Parse CodeLanguage

Defined in LiterateX.Types.CodeLanguage

Methods

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

Render CodeLanguage

Defined in LiterateX.Types.CodeLanguage

Methods

render :: Textual t => CodeLanguage -> t

data SourceFormat

Source format

This sum type defines the supported source formats.

Since: 0.0.1.0

Instances

Bounded SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

minBound :: SourceFormat

maxBound :: SourceFormat

Enum SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

succ :: SourceFormat -> SourceFormat

pred :: SourceFormat -> SourceFormat

toEnum :: Int -> SourceFormat

fromEnum :: SourceFormat -> Int

enumFrom :: SourceFormat -> [SourceFormat]

enumFromThen :: SourceFormat -> SourceFormat -> [SourceFormat]

enumFromTo :: SourceFormat -> SourceFormat -> [SourceFormat]

enumFromThenTo :: SourceFormat -> SourceFormat -> SourceFormat -> [SourceFormat]

Show SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

showsPrec :: Int -> SourceFormat -> ShowS

show :: SourceFormat -> String

showList :: [SourceFormat] -> ShowS

Eq SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

(==) :: SourceFormat -> SourceFormat -> Bool

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

Ord SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

compare :: SourceFormat -> SourceFormat -> Ordering

(<) :: SourceFormat -> SourceFormat -> Bool

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

(>) :: SourceFormat -> SourceFormat -> Bool

(>=) :: SourceFormat -> SourceFormat -> Bool

max :: SourceFormat -> SourceFormat -> SourceFormat

min :: SourceFormat -> SourceFormat -> SourceFormat

Parse SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

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

Render SourceFormat

Defined in LiterateX.Types.SourceFormat

Methods

render :: Textual t => SourceFormat -> t

data SourceLine

Parsed source line

Since: 0.0.1.0

Instances

Show SourceLine

Defined in LiterateX.Types.SourceLine

Methods

showsPrec :: Int -> SourceLine -> ShowS

show :: SourceLine -> String

showList :: [SourceLine] -> ShowS

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

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