Slick.Pandoc

Documentation

markdownToHTML :: Text -> Action Value

Convert markdown text into a Value;

The Value has a "content" key containing rendered HTML.

Metadata is assigned on the respective keys in the Value

markdownToHTML' :: FromJSON a => Text -> Action a

Like markdownToHTML but allows returning any JSON serializable object

markdownToHTMLWithOpts

Arguments

:: ReaderOptions

Pandoc reader options to specify extensions or other functionality

-> WriterOptions

Pandoc writer options to modify output

-> Text

Text for conversion

-> Action Value

Like markdownToHTML but allows providing additional pandoc reader and writer options

markdownToHTMLWithOpts'

Arguments

:: FromJSON a

=> ReaderOptions

Pandoc reader options to specify extensions or other functionality

-> WriterOptions

Pandoc writer options to modify output

-> Text

Text for conversion

-> Action a

Like markdownToHTMLWithOpts but returns any JSON serializable object.

orgModeToHTML :: Text -> Action Value

Convert org-mode text into a Value;

The Value has a "content" key containing rendered HTML.

Metadata is assigned on the respective keys in the Value

orgModeToHTML' :: FromJSON a => Text -> Action a

Like orgModeToHTML but allows returning any JSON compatible object.

orgModeToHTMLWithOpts

Arguments

:: ReaderOptions

Pandoc reader options to specify extensions or other functionality

-> WriterOptions

Pandoc writer options to modify output

-> Text

Text for conversion

-> Action Value

Like orgModeToHTML but allows providing additional pandoc reader and writer options

orgModeToHTMLWithOpts'

Arguments

:: FromJSON a

=> ReaderOptions

Pandoc reader options to specify extensions or other functionality

-> WriterOptions

Pandoc writer options to modify output

-> Text

Text for conversion

-> Action a

Like orgModeToHTMLWithOpts but allows returning any JSON compatible object

makePandocReader :: PandocReader textType -> textType -> Action (Pandoc, Value)

Given a reader from Readers this creates a loader which given the source document will read its metadata into a Value returning both the Pandoc object and the metadata within an Action. The metadata values will be read as Markdown but rendered as plain text, removing any links, pictures, and inline formatting.

makePandocReader' :: FromJSON a => PandocReader textType -> textType -> Action (Pandoc, a)

Like makePandocReader but will deserialize the metadata into any object which implements FromJSON. Failure to deserialize will fail the Shake build. Metadata values will be read as Markdown but rendered as plain text, removing any links, pictures, and inline formatting.

makePandocReaderWithMetaWriter :: PandocReader textType -> PandocWriter -> textType -> Action (Pandoc, Value)

Given a reader from Readers, and a writer from Writers, this creates a loader which given the source document will read its metadata as Markdown, then render it into a Value using the writer, returning both the Pandoc object and the metadata within an Action

makePandocReaderWithMetaWriter' :: FromJSON a => PandocReader textType -> PandocWriter -> textType -> Action (Pandoc, a)

Like makePandocReaderWithMetaWriter but will deserialize the metadata into any object which implements FromJSON. Failure to deserialize will fail the Shake build.

type PandocReader textType = textType -> PandocIO Pandoc

type PandocWriter = Pandoc -> PandocIO Text

loadUsing :: PandocReader textType -> PandocWriter -> textType -> Action Value

Load in a source document using the given PandocReader, then render the Pandoc into text using the given PandocWriter. Returns a Value wherein the rendered text is set to the "content" key and any metadata is set to its respective key in the Value

loadUsing' :: FromJSON a => PandocReader textType -> PandocWriter -> textType -> Action a

Like loadUsing but allows also deserializes the Value into any object which implements FromJSON. Failure to deserialize will fail the Shake build.

loadUsingMeta

Arguments

:: PandocReader textType

The reader used to load the document

-> PandocWriter

The writer used to render the document itself

-> PandocWriter

The writer used to process metadata.

-> textType

-> Action Value

Load in a source document using the given PandocReader, then render the Pandoc into text using the given PandocWriter. Takes a second PandocWriter to render metadata. Returns a Value wherein the rendered text is set to the "content" key and any metadata is set to its respective key in the Value

defaultMarkdownOptions :: ReaderOptions

Reasonable options for reading a markdown file. Behaves similar to Github Flavoured Markdown

defaultOrgModeOptions :: ReaderOptions

Reasonable options for reading an org-mode file

defaultHtml5Options :: WriterOptions

Reasonable options for rendering to HTML. Includes default code highlighting rules

convert :: (FromJSON a, ToJSON a, FromJSON b) => a -> Action b

Attempt to convert between two JSON serializable objects (or Values). Failure to deserialize fails the Shake build.

flattenMeta :: PandocWriter -> Meta -> Action Value

Flatten a Pandoc Meta into a well-structured JSON object, rendering Pandoc text objects into plain strings along the way.