-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Parse a Pandoc to a composite value.
--   
--   Provides a functionality for transforming a Pandoc into a
--   vinyl/composite record.
@package compdoc
@version 0.3.0.0


-- | Provides functionality for transforming a <a>Pandoc</a> into a
--   composite record.
module Text.Compdoc
type FContent = (:->) "content" Text
fContent :: forall f_aiKp rs_aiKq. (Functor f_aiKp, (∈) FContent rs_aiKq) => (Text -> f_aiKp Text) -> Record rs_aiKq -> f_aiKp (Record rs_aiKq)

-- | A Compdoc is a Record with at least an FContent field.
newtype Compdoc a
Compdoc :: Record (FContent : a) -> Compdoc a
[unCompdoc] :: Compdoc a -> Record (FContent : a)

-- | Read some <a>Pandoc</a> markdown as <a>Text</a> as a `Record (Compdoc
--   a)` supplying a <a>JsonFormat</a> for the metadata.
readMarkdown' :: (Show e, Typeable e, MonadThrow m) => ReaderOptions -> WriterOptions -> JsonFormat e (Record a) -> Text -> m (Compdoc a)

-- | Read a markdown file from disk, supplying a <a>JsonFormat</a> for the
--   metadata.
readMarkdownFile :: (MonadIO m, MonadThrow m, Show e, Typeable e) => ReaderOptions -> WriterOptions -> JsonFormat e (Record a) -> Path b File -> m (Compdoc a)

-- | Run a <a>PandocPure</a> operation with a default value in the event of
--   failure.
runPandocPureDefault :: a -> PandocPure a -> a

-- | Transform a <a>Pandoc</a> to a <a>Compdoc</a> supplying a `JsonFormat
--   for the metadata.
pandocToCompdoc :: (Typeable e, Show e, MonadThrow m) => (WriterOptions -> Pandoc -> PandocPure Text) -> WriterOptions -> JsonFormat e (Record a) -> Pandoc -> m (Compdoc a)

-- | Create the tail of a <a>Compdoc</a> which is just an <a>FContent</a>
--   field.
contentBlock :: WriterOptions -> [Block] -> Record (FContent : '[])

-- | Write a list of <a>Block</a>s to <a>Text</a> using
--   <a>WriterOptions</a> defaulting to the empty string in the case of
--   error.
writeBlocksDefault :: WriterOptions -> [Block] -> Text

-- | Flatten pandoc metadata to an aeson value.
flattenMeta :: MonadThrow m => (Pandoc -> PandocPure Text) -> Meta -> m Value