Hakyll.Alectryon

Hakyll extension for rendering Coq code blocks using Alectryon.

Import this module qualified:

import qualified Hakyll.Alectryon as Alectryon

The main two functions are:

• tryTransform: transform Pandoc documents, ignoring those where the alectryon field is not set.
• hakyllWith: extend the Hakyll CLI with an option to enable processing code blocks with Alectryon. This is disabled by default, assuming that the output is already cached.

Transformations

tryTransform :: Options -> Item Pandoc -> Compiler (Item Pandoc)

If the alectryon flag is set, transform.

Do nothing if "alectryon" flag is not set.

tryTransform_ :: Item Pandoc -> Compiler (Item Pandoc)

If the alectryon flag is set, transform.

Do nothing if "alectryon" flag is not set.

This is tryTransform with all options enabled.

transform

Arguments

:: Options

-> Maybe FilePath

Cache directory location

-> [String]

Alectryon options (e.g., Coq -Q, -R)

-> Pandoc

-> Compiler Pandoc

Convert alectryon and coq code blocks to HTML using Alectryon and pygments respectively.

Alectryon and pygments

transformAlectryon

Arguments

:: Options

-> Maybe FilePath

Cache file location

-> [String]

Alectryon options (e.g., Coq -Q, -R)

-> Pandoc

-> Compiler Pandoc

Convert alectryon code blocks to HTML using Alectryon.

transform opt cache args :: Pandoc -> Compiler Pandoc

transformPygments

Arguments

:: Options

-> Maybe FilePath

Cache file location

-> Pandoc

-> Compiler Pandoc

Convert coq code blocks to HTML using pygments.

Options

data Options

Configurations for hakyll-alectryon.

Avoid using the Options constructor directly, prefer record updates on defaultOptions.

Constructors

Options

Fields

• runAlectryon :: Bool

  If True, actually process code blocks using Alectryon and Pygments. If False, use the cached output, and fail if the cache is not found (this is to ensure the site is buildable without Alectryon).

• enableAll :: Bool

  If True, process all posts. If False, process only posts whose metadata contains an alectryon field set to a list.

  That list contains options to pass to the Alectryon executable. It defaults to the empty list if enableAll = True and it is not present in the metadata of a post.

defaultOptions :: Options

enabledOptions :: Options

Always run Alectryon on all posts.

hakyll :: (Options -> Rules ()) -> IO ()

hakyllWith :: Configuration -> (Options -> Rules ()) -> IO ()

optionParser :: Parser Options

Extend Hakyll with custom parsers

execParser :: Parser a -> Configuration -> IO (Options, a)

parserInfo :: Parser a -> Configuration -> ParserInfo (Options, a)

hakyllWithArgsParser :: Parser a -> Configuration -> (a -> Rules ()) -> IO ()

Low-level interface

updateAlectryonBlocks :: [Text] -> Pandoc -> Pandoc

updateBlocks :: Text -> [Text] -> Pandoc -> Pandoc

onCoqBlocks :: b -> (Text -> b) -> Block -> b

onAlectryonBlocks :: b -> (Text -> b) -> Block -> b

onBlocks :: Text -> b -> (Text -> b) -> Block -> b

doRunAlectryon :: Options -> Maybe FilePath -> [String] -> [Text] -> Compiler [Text]

Transform a list of blocks using alectryon.

If the input list is empty, return the empty list immediately, saving an external call.

doRunPygments :: Options -> Maybe FilePath -> [Text] -> Compiler [Text]

Transform a list of blocks using pygments.

If the input list is empty, return the empty list immediately, saving an external call.

name :: Text

"alectryon"

Call Alectryon

splitAlectryonHTML :: Text -> [Text]

Split Alectryon output.

callAlectryon :: [String] -> FilePath -> Text -> IO ()

Call the Alectryon executable.

Call Pygments

splitPygmentsHTML :: Text -> [Text]

Split pygments output.

callPygments :: Text -> IO Text

Call the pygments script.