Shakebook.Pandoc

Documentation

runPandocA :: (MonadAction m, MonadThrow m) => PandocIO a -> m a

Natural transformation from PandocIO to a MonadAction

newtype PandocActionException

Constructors

PandocActionException String

Instances

Eq PandocActionException

Defined in Shakebook.Pandoc

Methods

(==) :: PandocActionException -> PandocActionException -> Bool

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

Show PandocActionException

Defined in Shakebook.Pandoc

Methods

showsPrec :: Int -> PandocActionException -> ShowS

show :: PandocActionException -> String

showList :: [PandocActionException] -> ShowS

Exception PandocActionException

Defined in Shakebook.Pandoc

Methods

toException :: PandocActionException -> SomeException

fromException :: SomeException -> Maybe PandocActionException

displayException :: PandocActionException -> String

readMDFile :: (MonadAction m, MonadThrow m) => ReaderOptions -> Path Rel File -> m Pandoc

Read a markdown file as an Action.

readMDFileIn :: (MonadAction m, MonadThrow m) => ReaderOptions -> Path Rel Dir -> Path Rel File -> m Pandoc

Read a markdown file as an Action.

readMDFileWithin :: (MonadAction m, MonadThrow m) => ReaderOptions -> Within Rel (Path Rel File) -> m Pandoc

Like readMDFile but accepts a Within

needPandocImagesIn :: (MonadAction m, MonadThrow m) => Path Rel Dir -> Pandoc -> m ()

Find all the images in a Pandoc data structure and call need on them.

makePDFLaTeX :: (MonadAction m, MonadThrow m) => WriterOptions -> Pandoc -> m ByteString

Make a pdflatex in an Action.

progressivelyDemoteHeaders :: Cofree [] Pandoc -> Cofree [] Pandoc

Precarious function that demotes Header numbers within the Pandoc according to its depth in the Cofree. This is so that Headers that H1s that would correctly display for an HTML page will be lower in the table of contents in the PDF equivalent.

replaceUnusableImages :: MonadThrow m => [String] -> (Text -> Inline) -> Pandoc -> m Pandoc

For a list of file extensions, replace the images with an Inline based on its src path.

prefixAllImages :: Path Rel Dir -> Pandoc -> Pandoc

Prefix all images in a Pandoc with a directory.

flattenMeta :: MonadAction m => (Pandoc -> PandocIO Text) -> Meta -> m Value

Flatten a pandoc Meta object to a Value.

viewContent :: ToJSON a => a -> Text

View the "content" field of a JSON value.

viewSrcPath :: ToJSON a => a -> Text

View the "src-path" field of a JSON Value.

viewUrl :: ToJSON a => a -> Text

View the "url" field of a JSON Value.

loadMarkdownAsJSON :: (MonadAction m, MonadThrow m) => ReaderOptions -> WriterOptions -> Within Rel (Path Rel File) -> m Value

Get a JSON Value of Markdown Data with markdown body as "contents" field and the srcPath as "srcPath" field.