LiterateX.Renderer

This module implements the target renderer.

Types

data Options

Renderer options determine how output is rendered

Since: 0.0.1.0

Constructors

Options

Fields

• targetFormat :: !TargetFormat
• codeLanguage :: !(Maybe CodeLanguage)
• ignoreShebang :: !Bool

  True to ignore shebangs

• renderCode :: !Bool

  True to render code

• numberCodeLines :: !Bool

  True to number code lines

Instances

Show Options

Defined in LiterateX.Renderer

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

API

defaultOptions :: Options

Default options

• targetFormat: PandocMarkdown
• codeLanguage: Nothing
• ignoreShebang: True
• renderCode: True
• numberCodeLines: True

Since: 0.0.1.0

defaultOptionsFor :: CodeLanguage -> Options

Default options for the specified code language

Since: 0.0.1.0

render :: forall m. Monad m => Options -> ConduitT (Int, SourceLine) Text m ()

Create a Conduit transformer that renders using the specified options

The transformer consumes SourceLine values annotated with the line number and produces lines of output.

Since: 0.0.1.0