Rib.Parser.Pandoc

Helpers for working with Pandoc documents

Parsing

parse

Arguments

:: (ReaderOptions -> Text -> PandocIO Pandoc)

The pandoc text reader function to use, eg: readMarkdown

-> FilePath

-> Action Pandoc

Parse a lightweight markup language using Pandoc

parsePure :: (ReaderOptions -> Text -> PandocPure Pandoc) -> Text -> Pandoc

Pure version of parse

Rendering

render :: Monad m => Pandoc -> HtmlT m ()

Render a Pandoc document to HTML

renderPandocInlines :: Monad m => [Inline] -> HtmlT m ()

Render a list of Pandoc Inline values as Lucid HTML

Useful when working with Meta values from the document metadata.

Extracting information

extractMeta :: Pandoc -> Maybe (Either Text Value)

Extract the Pandoc metadata as JSON value

getH1 :: Monad m => Pandoc -> Maybe (HtmlT m ())

Get the top-level heading as Lucid HTML

getToC :: Monad m => Pandoc -> HtmlT m ()

Get the document table of contents

getFirstImg

Arguments

:: Pandoc

-> Maybe Text

Relative URL path to the image

Get the first image in the document if one exists

Re-exports

data Pandoc

Instances

Eq Pandoc

Defined in Text.Pandoc.Definition

Methods

(==) :: Pandoc -> Pandoc -> Bool

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

Data Pandoc

Defined in Text.Pandoc.Definition

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Pandoc -> c Pandoc

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Pandoc

toConstr :: Pandoc -> Constr

dataTypeOf :: Pandoc -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Pandoc)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Pandoc)

gmapT :: (forall b. Data b => b -> b) -> Pandoc -> Pandoc

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Pandoc -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Pandoc -> r

gmapQ :: (forall d. Data d => d -> u) -> Pandoc -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Pandoc -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Pandoc -> m Pandoc

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Pandoc -> m Pandoc

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Pandoc -> m Pandoc

Ord Pandoc

Defined in Text.Pandoc.Definition

Methods

compare :: Pandoc -> Pandoc -> Ordering

(<) :: Pandoc -> Pandoc -> Bool

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

(>) :: Pandoc -> Pandoc -> Bool

(>=) :: Pandoc -> Pandoc -> Bool

max :: Pandoc -> Pandoc -> Pandoc

min :: Pandoc -> Pandoc -> Pandoc

Read Pandoc

Defined in Text.Pandoc.Definition

Methods

readsPrec :: Int -> ReadS Pandoc

readList :: ReadS [Pandoc]

readPrec :: ReadPrec Pandoc

readListPrec :: ReadPrec [Pandoc]

Show Pandoc

Defined in Text.Pandoc.Definition

Methods

showsPrec :: Int -> Pandoc -> ShowS

show :: Pandoc -> String

showList :: [Pandoc] -> ShowS

Generic Pandoc

Defined in Text.Pandoc.Definition

Associated Types

type Rep Pandoc :: Type -> Type

Methods

from :: Pandoc -> Rep Pandoc x

to :: Rep Pandoc x -> Pandoc

Semigroup Pandoc

Defined in Text.Pandoc.Definition

Methods

(<>) :: Pandoc -> Pandoc -> Pandoc

sconcat :: NonEmpty Pandoc -> Pandoc

stimes :: Integral b => b -> Pandoc -> Pandoc

Monoid Pandoc

Defined in Text.Pandoc.Definition

Methods

mempty :: Pandoc

mappend :: Pandoc -> Pandoc -> Pandoc

mconcat :: [Pandoc] -> Pandoc

NFData Pandoc

Defined in Text.Pandoc.Definition

Methods

rnf :: Pandoc -> ()

ToJSON Pandoc

Defined in Text.Pandoc.Definition

Methods

toJSON :: Pandoc -> Value

toEncoding :: Pandoc -> Encoding

toJSONList :: [Pandoc] -> Value

toEncodingList :: [Pandoc] -> Encoding

FromJSON Pandoc

Defined in Text.Pandoc.Definition

Methods

parseJSON :: Value -> Parser Pandoc

parseJSONList :: Value -> Parser [Pandoc]

HasMeta Pandoc

Defined in Text.Pandoc.Builder

Methods

setMeta :: ToMetaValue b => Text -> b -> Pandoc -> Pandoc

deleteMeta :: Text -> Pandoc -> Pandoc

Walkable Block Pandoc

Defined in Text.Pandoc.Walk

Methods

walk :: (Block -> Block) -> Pandoc -> Pandoc

walkM :: (Monad m, Applicative m, Functor m) => (Block -> m Block) -> Pandoc -> m Pandoc

query :: Monoid c => (Block -> c) -> Pandoc -> c

Walkable Inline Pandoc

Defined in Text.Pandoc.Walk

Methods

walk :: (Inline -> Inline) -> Pandoc -> Pandoc

walkM :: (Monad m, Applicative m, Functor m) => (Inline -> m Inline) -> Pandoc -> m Pandoc

query :: Monoid c => (Inline -> c) -> Pandoc -> c

Walkable Pandoc Pandoc

Defined in Text.Pandoc.Walk

Methods

walk :: (Pandoc -> Pandoc) -> Pandoc -> Pandoc

walkM :: (Monad m, Applicative m, Functor m) => (Pandoc -> m Pandoc) -> Pandoc -> m Pandoc

query :: Monoid c => (Pandoc -> c) -> Pandoc -> c

Walkable [Block] Pandoc

Defined in Text.Pandoc.Walk

Methods

walk :: ([Block] -> [Block]) -> Pandoc -> Pandoc

walkM :: (Monad m, Applicative m, Functor m) => ([Block] -> m [Block]) -> Pandoc -> m Pandoc

query :: Monoid c => ([Block] -> c) -> Pandoc -> c

Walkable [Inline] Pandoc

Defined in Text.Pandoc.Walk

Methods

walk :: ([Inline] -> [Inline]) -> Pandoc -> Pandoc

walkM :: (Monad m, Applicative m, Functor m) => ([Inline] -> m [Inline]) -> Pandoc -> m Pandoc

query :: Monoid c => ([Inline] -> c) -> Pandoc -> c

type Rep Pandoc

Defined in Text.Pandoc.Definition

type Rep Pandoc = D1 (MetaData "Pandoc" "Text.Pandoc.Definition" "pandoc-types-1.21-GnTQihHZh0GEvs1D4ZNs5S" False) (C1 (MetaCons "Pandoc" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Meta) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Block])))

module Text.Pandoc.Readers