Hakyll.Main

Module providing the main hakyll function and command-line argument parsing

Entry points

hakyll :: Rules a -> IO ()

This usually is the function with which the user runs the hakyll compiler

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

A variant of hakyll which allows the user to specify a custom configuration

hakyllWithArgs :: Configuration -> Options -> Rules a -> IO ()

A variant of hakyll which expects a Configuration and command-line Options. This gives freedom to implement your own parsing.

hakyllWithExitCode :: Configuration -> Rules a -> IO ExitCode

A variant of hakyll which returns an ExitCode

hakyllWithExitCodeAndArgs :: Configuration -> Options -> Rules a -> IO ExitCode

Command line argument parsers

data Options

The parsed command-line options.

Constructors

Options

Fields

• verbosity :: Bool
• optCommand :: Command

Instances

Show Options

Defined in Hakyll.Main

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

data Command

The command to run.

Constructors

Build RunMode

Generate the site.

Check

Validate the site output.

Fields

• internal_links :: Bool

Clean

Clean up and remove cache.

Deploy

Upload/deploy your site.

Preview

Deprecated: Use Watch instead.

DEPRECATED

Please use the watch command.

Fields

• port :: Int

Rebuild

Clean and build again.

Server

Start a preview server.

Fields

• host :: String
• port :: Int

Watch

Autocompile on changes and start a preview server.

Fields

• host :: String
• port :: Int
• no_server :: Bool

Instances

Show Command

Defined in Hakyll.Main

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

optionParser :: Configuration -> Parser Options

commandParser :: Configuration -> Parser Command

defaultCommands :: Configuration -> [(String, Parser Command, InfoMod a)]

defaultParser :: Configuration -> IO Options

defaultParserPure :: Configuration -> [String] -> ParserResult Options

defaultParserPrefs :: ParserPrefs

defaultParserInfo :: Configuration -> ParserInfo Options