Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Modulehakyll-4.17.0.0Haskell2010

Hakyll.Main

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

Contents

Entry points
Command line argument parsers

Synopsis

value hakyll
value hakyllWith
value hakyllWithArgs
value hakyllWithExitCode
value hakyllWithExitCodeAndArgs
data Options
data Command
value optionParser
value commandParser
value defaultCommands
value defaultParser
value defaultParserPure
value defaultParserPrefs
value defaultParserInfo

Packagehakyll-4.17.0.0
Exports14
LanguageHaskell2010
LicenceBSD-3-Clause
SourceMain.hs

Entry points

valuehakyll :: Rules a -> IO ()

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

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

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

valuehakyllWithArgs :: 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.

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

A variant of hakyll which returns an ExitCode

valuehakyllWithExitCodeAndArgs

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

Command line argument parsers

datadata Options

The parsed command-line options.

Constructors

Options
- verbosity :: Bool
- optCommand :: Command

Instances1Show

Show OptionsDefined in hakyll-4.17.0.0 · Hakyll.Main

datadata Command

The command to run.

Constructors

Build RunMode
Generate the site.
Check
Validate the site output.
- internal_links :: Bool
Clean
Clean up and remove cache.
Deploy
Upload/deploy your site.
Preview
DEPRECATED
Please use the watch command.
- port :: Int
Rebuild
Clean and build again.
Server
Start a preview server.
- host :: String
- port :: Int
Watch
Autocompile on changes and start a preview server.
- host :: String
- port :: Int
- no_server :: Bool

Instances1Show

Show CommandDefined in hakyll-4.17.0.0 · Hakyll.Main

valueoptionParser :: Configuration -> Parser Options

valuecommandParser :: Configuration -> Parser Command

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

valuedefaultParser :: Configuration -> IO Options

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

valuedefaultParserPrefs :: ParserPrefs

valuedefaultParserInfo :: Configuration -> ParserInfo Options